diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2017-01-29 22:10:37 +0100 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2017-01-29 22:10:37 +0100 |
| commit | edb96f69f52daa53547a90a392dbdd51cdcfa7f5 (patch) | |
| tree | b32d607e622005c3f37e0a42d1fb92c8d57bc9d7 /docs | |
| parent | e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6 (diff) | |
| download | mitmproxy-edb96f69f52daa53547a90a392dbdd51cdcfa7f5.tar.gz mitmproxy-edb96f69f52daa53547a90a392dbdd51cdcfa7f5.tar.bz2 mitmproxy-edb96f69f52daa53547a90a392dbdd51cdcfa7f5.zip | |
add contributing section that redirects to README
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/contributing.rst | 11 | ||||
| -rw-r--r-- | docs/index.rst | 3 | ||||
| -rw-r--r-- | docs/install.rst | 4 |
3 files changed, 15 insertions, 3 deletions
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst new file mode 100644 index 00000000..8e04c270 --- /dev/null +++ b/docs/dev/contributing.rst @@ -0,0 +1,11 @@ +.. _contributing: + +Contributing +============ + +As an open source project, **mitmproxy** welcomes contributions of all forms. + +Please head over to the README_ to get started! 😃 + + +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 9fcededc..8ba14f54 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,8 +78,9 @@ .. toctree:: :hidden: - :caption: Hacking + :caption: Development + dev/contributing dev/sslkeylogfile .. Indices and tables diff --git a/docs/install.rst b/docs/install.rst index 9a2aca0a..b9524897 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -139,11 +139,11 @@ Latest Development Version If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, install the dependencies as you would for a regular installation from source. Then see the -Hacking_ section of the README on GitHub. You can check your system information +project's README_ on GitHub. You can check your system information by running: ``mitmproxy --version`` -.. _Hacking: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst#hacking +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst .. _releases: https://github.com/mitmproxy/mitmproxy/releases .. _mitmproxy.org: https://mitmproxy.org/ .. _`Python website`: https://www.python.org/downloads/windows/ |