From bd55fd03e9d01f5adb65f7a0c8ecce823aeedd84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Fri, 5 Apr 2024 11:01:25 +0200 Subject: [PATCH] docs: add a requirements section to the developer docs. Add a section on installing sed, which differs between GNU and OSX. --- docs/developer/requirements.md | 17 +++++++++++++++++ docs/index.md | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/developer/requirements.md diff --git a/docs/developer/requirements.md b/docs/developer/requirements.md new file mode 100644 index 0000000..bd61fef --- /dev/null +++ b/docs/developer/requirements.md @@ -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 +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4d1a280..3b02d99 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,6 +56,7 @@ checks ```{toctree} :caption: Developer docs :hidden: +developer/requirements developer/overview developer/dependencies developer/new-check