Skip to content

Commit 51018dc

Browse files
committed
Fix typo, cleanup Makefile, add installation instruction
1 parent 27b6b2b commit 51018dc

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
8282
flake8 bbox_visualizer demo
8383
```
8484
85-
To get flake8, just pip install int into your virtualenv.
85+
To get flake8, just pip install it into your virtualenv.
8686
8787
6. Commit your changes and push your branch to GitHub::
8888

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ docs: ## generate Sphinx HTML documentation, including API docs
5454
rm -f docs/bbox_visualizer.rst
5555
rm -f docs/modules.rst
5656
sphinx-apidoc -o docs/ bbox_visualizer
57+
rm -f docs/bbox_visualizer.rst
58+
rm -f docs/modules.rst
5759
$(MAKE) -C docs clean
5860
$(MAKE) -C docs html
5961
$(BROWSER) docs/_build/html/index.html

docs/installation.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ Once you have a copy of the source, you can install it with:
4646
4747
$ python setup.py install
4848
49+
or
50+
51+
.. code-block:: console
52+
53+
$ pip install . --user
54+
4955
5056
.. _Github repo: https://github.com/shoumikchow/bbox-visualizer
5157
.. _tarball: https://github.com/shoumikchow/bbox-visualizer/tarball/master

0 commit comments

Comments
 (0)