diff --git a/README.md b/README.md index c3da5f889da303eb47aaf7d87c5ddb53fcc67426..a98bc01d6e229070e0c887b0fc730db4d2478779 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ 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/]. +[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 @@ -23,7 +23,7 @@ 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 -``` +```julia using BDIO BDIO_set_user("username") BDIO_set_host("laptop")