File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -13,10 +13,20 @@ Clone AboutCode
1313
1414Create or identify a working directory on your local machine.
1515
16- Open that directory and execute the following commands in a terminal session::
16+ Open that directory and execute the following command in a terminal session::
1717
1818 git clone https://github.com/nexB/aboutcode.git
19- git status
19+
20+ That will create an /aboutcode directory in your working directory.
21+ Now you can install the dependencies in a virtualenv::
22+
23+ cd aboutcode
24+ python3.6 -m venv .
25+ source bin/activate
26+ pip install Sphinx sphinx_rtd_theme
27+
28+ Now you can build the HTML documents locally::
29+
2030 cd docs
2131 make html
2232
@@ -50,8 +60,8 @@ Share AboutCode Document Improvements
5060Follow standard git procedures to upload your new and modified files. The following commands are examples::
5161
5262 git status
53- git add docs/ source/index.rst
54- git add docs/ source/how-to-scan.rst
63+ git add source/index.rst
64+ git add source/how-to-scan.rst
5565 git status
5666 git commit -m "New how-to document that explains how to scan"
5767 git status
You can’t perform that action at this time.
0 commit comments