aboutsummaryrefslogtreecommitdiffstats
path: root/dev/README.rst
diff options
context:
space:
mode:
authorGravatar ChrisJL <[email protected]>2022-11-05 14:15:11 +0000
committerGravatar GitHub <[email protected]>2022-11-05 14:15:11 +0000
commit3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd (patch)
tree11d77db3a48d8226bc1cd14cb18a21d2423b6352 /dev/README.rst
parentUse New Static Build Site API (#122) (diff)
parentAdd six as a dev dep (diff)
Merge pull request #157 from python-discord/prepare-for-pypi-releasev9.0.0
Prepare for pypi release
Diffstat (limited to 'dev/README.rst')
-rw-r--r--dev/README.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/dev/README.rst b/dev/README.rst
index ae4f3adc..9428d788 100644
--- a/dev/README.rst
+++ b/dev/README.rst
@@ -3,7 +3,7 @@ Local Development & Testing
To test your features locally, there are a few possible approaches:
-1. Install your local copy of botcore into a pre-existing project such as bot
+1. Install your local copy of pydis_core into a pre-existing project such as bot
2. Use the provided template from the :repo-file:`dev/bot <dev/bot>` folder
See below for more info on both approaches.
@@ -17,12 +17,12 @@ vary by the feature you're working on.
Option 1
--------
1. Navigate to the project you want to install bot-core in, such as bot or sir-lancebot
-2. Run ``pip install /path/to/botcore`` in the project's environment
+2. Run ``pip install /path/to/pydis_core`` in the project's environment
- The path provided to install should be the root directory of this project on your machine.
That is, the folder which contains the ``pyproject.toml`` file.
- Make sure to install in the correct environment. Most Python Discord projects use
- poetry, so you can run ``poetry run pip install /path/to/botcore``.
+ poetry, so you can run ``poetry run pip install /path/to/pydis_core``.
3. You can now use features from your local bot-core changes.
To load new changes, run the install command again.