From 7659508fd2d85cc09ecf46335bb1bfe38428b74f Mon Sep 17 00:00:00 2001 From: Michael Boniface <m.j.boniface@soton.ac.uk> Date: Sat, 22 Feb 2025 17:04:02 +0000 Subject: [PATCH] docs: finalised developer documentation. closes #7 --- docs/index.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 741e5d3..a241674 100644 --- a/docs/index.md +++ b/docs/index.md @@ -208,18 +208,25 @@ We have two separate environments to ensure that development dependencies (such - default environment: includes the core dependencies to run acmc (e.g., requests, etc.). - dev environment: includes additional tools for testing, code formatting, linting, and other development workflows (e.g., pytest, black, mypy, etc.). +### Activate the Development Environment +To enter the (dev) development environment, use: + +```sh +hatch shell dev +``` + ### Activate Production Environment -To enter the production environment, use: +To enter the (acmc) production environment, use: ```sh hatch shell ``` -### Activate the Development Environment -To enter the development environment, use: +### Deactivate Environment +To exist an environment from hatch, use: ```sh -hatch shell dev +exit ``` ### Code Formatting -- GitLab