diff options
| author | Giampaolo Rodola <g.rodola@gmail.com> | 2020-02-12 02:44:33 +0100 |
|---|---|---|
| committer | Giampaolo Rodola <g.rodola@gmail.com> | 2020-02-12 02:44:33 +0100 |
| commit | 3e2ee4f26f171e05b9b38a270c6baab63edb3f7e (patch) | |
| tree | bb353e53de5ffea148a36cdcfc1b7108a7d94939 /docs/DEVGUIDE.rst | |
| parent | 579921dd7fb7de09295e5e8f4e5d02ba0e359c23 (diff) | |
| download | psutil-3e2ee4f26f171e05b9b38a270c6baab63edb3f7e.tar.gz | |
refactor doc
Diffstat (limited to 'docs/DEVGUIDE.rst')
| -rw-r--r-- | docs/DEVGUIDE.rst | 29 |
1 files changed, 6 insertions, 23 deletions
diff --git a/docs/DEVGUIDE.rst b/docs/DEVGUIDE.rst index 598c8b61..e07d977e 100644 --- a/docs/DEVGUIDE.rst +++ b/docs/DEVGUIDE.rst @@ -1,24 +1,13 @@ -Setup and running tests -======================= - -If you plan on hacking on psutil this is what you're supposed to do first: +Build, setup and running tests +=============================== -- clone the GIT repository: - -.. code-block:: bash - - $ git clone git@github.com:giampaolo/psutil.git - -- install test deps and GIT hooks: +Make sure to `install <https://github.com/giampaolo/psutil/blob/master/INSTALL.rst>`__ +a C compiler first, then: .. code-block:: bash + git clone git@github.com:giampaolo/psutil.git make setup-dev-env - -- run tests: - -.. code-block:: bash - make test - bear in mind that ``make``(see `Makefile`_) is the designated tool to run @@ -60,13 +49,7 @@ On Windows: .. code-block:: bat - set PYTHON=C:\python35\python.exe && make test - -...or: - -.. code-block:: bat - - make -p 35 test + make -p C:\python35\python.exe test If you want to modify psutil and run a script on the fly which uses it do (on UNIX): |