docs: add a requirements section to the developer docs.

Add a section on installing sed, which differs between GNU and OSX.
This commit is contained in:
Alexis Métaireau 2024-04-05 11:01:25 +02:00
parent 4821fe8c0a
commit bd55fd03e9
2 changed files with 18 additions and 0 deletions

View file

@ -0,0 +1,17 @@
# Requirements
Depending on your setup, you might need different tools to develop on argos. We try to list them here.
## Mac OS
### Gnu Sed
You will need to have gnu-sed installed. "sed" installed by default on MacOS machines differ from the gnu version (It's used for some post-documentation-generation hooks)
```bash
brew install gnu-sed
# This will explain how to add it to your path (to replace the default one)
brew info gnu-sed
```

View file

@ -56,6 +56,7 @@ checks
```{toctree} ```{toctree}
:caption: Developer docs :caption: Developer docs
:hidden: :hidden:
developer/requirements
developer/overview developer/overview
developer/dependencies developer/dependencies
developer/new-check developer/new-check