Commit 85e1f856 authored by Alberto Ramos's avatar Alberto Ramos

Minor modification in docs and README

parent 85e62812
......@@ -4,14 +4,31 @@
BDIO.jl is a package to write/read [BDIO](http://bdio.org) (**B**inary
**D**ata **I**nput/**O**utput) files.
The full documentation of the package is available via the usual
(Julia `REPL` help
mode)[https://docs.julialang.org/en/v1/stdlib/REPL/#Help-mode-1] and
online in (HTML format)[https://ific.uv.es/~alramos/docs/BDIO/].
## Install
The easiest way is to use the package manager
The package in not in the general registry. Still one can use the package manager
```julia
julia> import Pkg
(v1.1) pkg> add https://gitlab.ift.uam-csic.es/alberto/bdio.jl
```
## Configuration
The package does not require much configuration, but it is recommended
that the variables `user` and `host` contain reasonable values. Since
`BDIO` is a light package, probably the easiest is to add to your
`~/.julia/config/startup.jl` something like
```
using BDIO
BDIO_set_user("username")
BDIO_set_host("laptop")
```
## Example
The test1.jl file in the `tests` directory gives a simple example on
......
......@@ -37,8 +37,7 @@ records). We can see the contents using the [`lsbdio`
tool](http://bdio.org/).
```
┌─(Wed Jul 1 09:32:00 2020)──[localhost]──[/u/h/a/c/j/B/docs/src]
└─> $ lsbdio foo.bdio
$ lsbdio foo.bdio
ID record type size uinf starts with long
0 header v 1 alberto@laptop Wed Jul 1 09:31:24 2020
1 record i64 le 8000 byte 1 1 2 3 4 5 6 7 8 9 10 11 12 13 x
......
......@@ -31,6 +31,6 @@ const BDIO_BIN_F64 = 243
const BDIO_HASH_MAGIC_S = 1515784845
user = " "
host = " "
user = "bowman"
host = "hal9000"
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