Skip to content

Commit da982d4

Browse files
authored
docs: Update repo name in readme and docs (#274)
1 parent 3a3e3bf commit da982d4

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

.github/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ pip install qctrl-open-controls
4343
### From Source
4444

4545
The source code is hosted on
46-
[Github](https://github.com/qctrl/python-open-controls). The repository can be
46+
[GitHub](https://github.com/qctrl/open-controls). The repository can be
4747
cloned using
4848

4949
```shell
50-
git clone [email protected]:qctrl/python-open-controls.git
50+
git clone [email protected]:qctrl/open-controls.git
5151
```
5252

5353
Once the clone is complete, you have two options:
@@ -61,23 +61,22 @@ Once the clone is complete, you have two options:
6161
After you have installed Poetry, use:
6262

6363
```bash
64-
cd python-open-controls
64+
cd open-controls
6565
poetry install
6666
```
6767

6868
1. Using pip
6969

7070
```shell
71-
cd python-open-controls
71+
cd open-controls
7272
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
7373
pip install -r requirements.txt
7474
pip install -e .
7575
rm requirements.txt
7676
```
7777

7878
Once installed via one of the above methods, test your installation by running
79-
`pytest`
80-
in the `python-open-controls` directory.
79+
`pytest` in the `open-controls` directory.
8180

8281
```shell
8382
pytest
@@ -129,7 +128,7 @@ Code is formatted, linted and checked using the following tools:
129128
- [isort](https://github.com/timothycrosley/isort)
130129
- [mypy](http://mypy-lang.org/)
131130

132-
These checks are run on all code merged to master, and may also be run locally from the python-open-controls
131+
These checks are run on all code merged to master, and may also be run locally from the open-controls
133132
directory:
134133

135134
```shell
@@ -146,7 +145,7 @@ See the [official documentation](https://pylint.readthedocs.io/en/latest/user_gu
146145
for details.
147146

148147
Black and isort, in addition to checking code, can also automatically apply fixes. To fix all code
149-
in the python-open-controls tree, run:
148+
in the open-controls tree, run:
150149

151150
```shell
152151
isort
@@ -166,13 +165,13 @@ With this, the checks will run every time that you commit code with
166165
instead of when you commit changes, use `pre-commit install -t pre-push`.
167166

168167
If you no longer wish to use `pre-commit`, you can uninstall it by running
169-
`pre-commit uninstall` in the `python-open-controls` directory (or by running
168+
`pre-commit uninstall` in the `open-controls` directory (or by running
170169
`pre-commit uninstall -t pre-push`, if you used the pre-push hooks).
171170

172171
## Credits
173172

174173
See
175-
[Contributors](https://github.com/qctrl/python-open-controls/graphs/contributors).
174+
[Contributors](https://github.com/qctrl/open-controls/graphs/contributors).
176175

177176
## License
178177

docs/installation.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ From Source
3333
-----------
3434

3535
The source code is hosted on
36-
`Github <https://github.com/qctrl/python-open-controls>`_. The repository can be
36+
`GitHub <https://github.com/qctrl/open-controls>`_. The repository can be
3737
cloned using
3838

3939
.. code-block:: shell
4040
41-
git clone [email protected]:qctrl/python-open-controls.git
41+
git clone [email protected]:qctrl/open-controls.git
4242
4343
Once the clone is complete, you have two options:
4444

@@ -54,23 +54,22 @@ Once the clone is complete, you have two options:
5454

5555
.. code-block:: shell
5656
57-
cd python-open-controls
57+
cd open-controls
5858
poetry install
5959
6060
#.
6161
Using pip
6262

6363
.. code-block:: shell
6464
65-
cd python-open-controls
65+
cd open-controls
6666
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
6767
pip install -r requirements.txt
6868
pip install -e .
6969
rm requirements.txt
7070
7171
Once installed via one of the above methods, test your installation by running
72-
``pytest``
73-
in the ``python-open-controls`` directory.
72+
``pytest`` in the ``open-controls`` directory.
7473

7574
.. code-block:: shell
7675

0 commit comments

Comments
 (0)