From 8977f48028e590b91be53ad9be08d23bfe672339 Mon Sep 17 00:00:00 2001 From: florian <f.spreckelsen@inidscale.com> Date: Wed, 4 Aug 2021 17:30:10 +0200 Subject: [PATCH] DOC: Add hint on code formatting --- README_SETUP.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README_SETUP.md b/README_SETUP.md index c54effe..3e5ecdb 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -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 -- GitLab