Skip to content
Snippets Groups Projects
Commit 8977f480 authored by florian's avatar florian
Browse files

DOC: Add hint on code formatting

parent fbb232a9
No related branches found
No related tags found
1 merge request!6DOC: Add sections to documentation
......@@ -44,6 +44,26 @@ julia> ]activate "/path/to/caosdb-julialib"
julia> ]test
```
## Code styling
We use
[JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) for
automatic code formatting. Simply install JuliaFormatter by
```julia-repl
julia> ]add JuliaFormatter
```
and execute
```sh
julia -e 'using JuliaFormatter; format(".", verbose=true)'
```
in the root directory of caosdb-julialib. You may leave out the
`verbose=true` option if you do not wish to see which files were
formatted.
## Documentation
The documentation can be built locally using
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment