From a580813d8fe2598f7c906f4603fb245cac91c28c Mon Sep 17 00:00:00 2001 From: Riccardo Foffi Date: Fri, 29 Dec 2023 16:26:19 +0100 Subject: [PATCH] broken docs; describe method to build locally --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d495f87..1b1dfb2 100644 --- a/README.md +++ b/README.md @@ -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)