Added readme for devs
All checks were successful
Test before pr merge / test-lint (pull_request) Successful in 7s
Build on push / prepare (push) Successful in 11s
Build on push / query (push) Successful in 19s
Build on push / core (push) Successful in 20s
Build on push / cli (push) Successful in 19s
Build on push / dependency (push) Successful in 19s
Build on push / database (push) Successful in 17s
Build on push / application (push) Successful in 17s
Build on push / translation (push) Successful in 21s
Build on push / mail (push) Successful in 21s
Build on push / auth (push) Successful in 15s
Build on push / api (push) Successful in 15s
All checks were successful
Test before pr merge / test-lint (pull_request) Successful in 7s
Build on push / prepare (push) Successful in 11s
Build on push / query (push) Successful in 19s
Build on push / core (push) Successful in 20s
Build on push / cli (push) Successful in 19s
Build on push / dependency (push) Successful in 19s
Build on push / database (push) Successful in 17s
Build on push / application (push) Successful in 17s
Build on push / translation (push) Successful in 21s
Build on push / mail (push) Successful in 21s
Build on push / auth (push) Successful in 15s
Build on push / api (push) Successful in 15s
This commit is contained in:
18
README.md
18
README.md
@@ -0,0 +1,18 @@
|
|||||||
|
## Prepare for development
|
||||||
|
|
||||||
|
After cloning the repository, run the following commands to set up your development environment:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
|
||||||
|
bash install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Install cpl-cli as a development package:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e src/core
|
||||||
|
pip install -e src/cli
|
||||||
|
```
|
||||||
|
|
||||||
|
When using Pycharm, mark all directories under `src/` as "Sources Root" and `exa` to ensure proper module resolution.
|
||||||
Reference in New Issue
Block a user