Skip to content

Commit 8e760c7

Browse files
committed
Docs on installing
1 parent 9e38a50 commit 8e760c7

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ It is Python tool that can be used as a library from other Python programmes, or
1010
.. toctree::
1111

1212
features.rst
13+
installing.rst
1314
cli.rst
1415

docs/installing.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Installing
2+
==========
3+
4+
To install,
5+
6+
1) Check out the git repository ( https://github.com/OpenDataServices/compile-to-json-schema ) onto your machine.
7+
8+
2) In that directory, create a new Python Virtual Environment (or similar, using the tool of your choice).
9+
10+
3) To install the tool and it's dependencies, run:
11+
12+
.. code-block:: shell-session
13+
14+
pip install -e .
15+
16+
If you will want to develop the tool, instead run:
17+
18+
.. code-block:: shell-session
19+
20+
pip install -e .[test]
21+
22+
4) The tool should now be available! Run
23+
24+
25+
.. code-block:: shell-session
26+
27+
compiletojsonschema --help

0 commit comments

Comments
 (0)