Skip to content

Commit

Permalink
broken docs; describe method to build locally
Browse files Browse the repository at this point in the history
  • Loading branch information
mastrof committed Dec 29, 2023
1 parent 56a6e53 commit a580813
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Contributions, requests and suggestions are more than welcome.
**To use the latest development version of MicrobeAgents it's required to manually install
the latest version of Agents first (`]add Agents#main`).**

**Documentation deployment is currently broken due to dependency on unreleased Agents.jl version; you can build it locally with the following code (requires the LiveServer.jl package):**
```
git clone https://github.com/mastrof/MicrobeAgents.jl.git
cd MicrobeAgents.jl
julia --project=docs/ -e 'import Pkg; Pkg.instantiate(); Pkg.add(name="Agents", rev="main"); include("docs/make.jl")'
julia -e 'using LiveServer; serve(dir="docs/build")'
```

## Main features
- Multiple swimming strategies (run-tumble, run-reverse, run-reverse-flick) with tunable parameters, and possibility to implement your own with minimal effort
- Classical and modern models of chemotaxis (Berg-Purcell, Celani-Vergassola, Xie, Brumley)
Expand Down

0 comments on commit a580813

Please sign in to comment.