Commit b2b27cac authored by Alberto Ramos's avatar Alberto Ramos

Installation instructions included

parent 58f09bc9
...@@ -4,9 +4,21 @@ ...@@ -4,9 +4,21 @@
BDIO.jl is a package to write/read [BDIO](http://bdio.org) (**B**inary BDIO.jl is a package to write/read [BDIO](http://bdio.org) (**B**inary
**D**ata **I**nput/**O**utput) files. **D**ata **I**nput/**O**utput) files.
## Install
The easiest way is to use the package manager
```julia
julia> import Pkg
(v1.1) pkg> add https://gitlab.ift.uam-csic.es/alberto/bdio.jl
```
## Example
The test1.jl file in the `tests` directory gives a simple example on The test1.jl file in the `tests` directory gives a simple example on
the usage of the package the usage of the package
```julia ```julia
julia> using BDIO
julia> BDIO_set_user("alberto") julia> BDIO_set_user("alberto")
julia> BDIO_set_host("laptop") julia> BDIO_set_host("laptop")
julia> fb = BDIO_open("foo.bdio", "w", "Test file") julia> fb = BDIO_open("foo.bdio", "w", "Test file")
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment