mirror of
https://github.com/Hopiu/llm.git
synced 2026-05-11 23:33:10 +00:00
AGENTS.md file for Codex
This commit is contained in:
parent
12b6ea6977
commit
ac0506e15b
1 changed files with 30 additions and 0 deletions
30
AGENTS.md
Normal file
30
AGENTS.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Repository maintenance notes
|
||||
|
||||
This project uses a Python virtual environment for development and tests.
|
||||
|
||||
## Setting up a development environment
|
||||
|
||||
1. Create and activate a virtual environment:
|
||||
|
||||
```bash
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
2. Install the project with its test dependencies:
|
||||
```bash
|
||||
pip install -e '.[test]'
|
||||
```
|
||||
3. Run the tests:
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
## Building the documentation
|
||||
|
||||
Run the following commands if you want to build the docs locally:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
pip install -r requirements.txt
|
||||
make html
|
||||
```
|
||||
Loading…
Reference in a new issue