diff --git a/docs/index.md b/docs/index.md index 741e5d35f8fcd15464238aa7b33f14c0770d2495..a2416745ecd872c0ea6594ac3b582d20a06f356c 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