summaryrefslogtreecommitdiff
path: root/source/building.rst
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2018-10-29 21:50:52 +0100
committerJan Dittberner <jandd@cacert.org>2018-10-29 21:50:52 +0100
commit37687377cc5b3478bc3db7f41e27e954ea0a16a5 (patch)
tree410869f2bce1b480671e8d1bb86c9d87ccd0a917 /source/building.rst
parent16c091b286546ec424b8dfd5afdea1ec2b21db10 (diff)
downloadcacert-codedocs-37687377cc5b3478bc3db7f41e27e954ea0a16a5.tar.gz
cacert-codedocs-37687377cc5b3478bc3db7f41e27e954ea0a16a5.tar.xz
cacert-codedocs-37687377cc5b3478bc3db7f41e27e954ea0a16a5.zip
Add license and github instructions
Diffstat (limited to 'source/building.rst')
-rw-r--r--source/building.rst23
1 files changed, 19 insertions, 4 deletions
diff --git a/source/building.rst b/source/building.rst
index e3faeae..fec9e5d 100644
--- a/source/building.rst
+++ b/source/building.rst
@@ -16,10 +16,20 @@ You can clone the repository anonymously by executing::
git clone git://git.cacert.org/cacert-codedocs.git
-If you want to contribute to the documentation please ask git-admin@cacert.org
-to setup a user in the group git-doc on git.cacert.org for you. You will have
-to provide an SSH public key (either RSA with at least 2048 Bits modulus or an
-ECDSA or ED25519 key with similar strength) with your request.
+There is a github mirror of this repository available at
+
+ https://github.com/CAcertOrg/cacert-codedocs
+
+You make fork from that clone and contribute your changes via pull requests.
+Merged pull requests will be applied to the repository at git.cacert.org.
+
+If you just want to contribute to the documentation you are encouraged to use
+Github and pull requests.
+
+Please ask git-admin@cacert.org to setup a user in the group git-doc on
+git.cacert.org for you to get push access to the git.cacert.org repository.
+You will have to provide an SSH public key (either RSA with at least 2048 Bits
+modulus or an ECDSA or ED25519 key with similar strength) with your request.
If you have a user in the git-doc group you can clone the repository by
executing::
@@ -57,6 +67,11 @@ Python 3 installation instructions can be found on the `Python website`_.
.. note::
+ You may need to add :file:`~/.local/bin` to the :envvar:`$PATH`
+ environment variable before you will be able to run :program:`pipenv`.
+ You can do this by adding ``export PATH=~/.local/bin:$PATH`` to your
+ shell initialization file like :file:`~/.bashrc` or :file:`~/.zshrc`.
+
The above commands should be run from the root directory of a git clone
of the cacert-codedocs git repository. The result of the :program:`make`
exection will be available in the :file:`build/html/` directory