Skip to content
Snippets Groups Projects
Commit 7659508f authored by mjbonifa's avatar mjbonifa
Browse files

docs: finalised developer documentation. closes #7

parent 1a222e6b
No related branches found
No related tags found
Loading
...@@ -208,18 +208,25 @@ We have two separate environments to ensure that development dependencies (such ...@@ -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.). - 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.). - 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 ### Activate Production Environment
To enter the production environment, use: To enter the (acmc) production environment, use:
```sh ```sh
hatch shell hatch shell
``` ```
### Activate the Development Environment ### Deactivate Environment
To enter the development environment, use: To exist an environment from hatch, use:
```sh ```sh
hatch shell dev exit
``` ```
### Code Formatting ### Code Formatting
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment