From 8c2ba7e8fe1500e54f5d4e48b98c755ad3f6e525 Mon Sep 17 00:00:00 2001 From: amosbastian Date: Tue, 29 Jan 2019 21:48:41 +0000 Subject: [PATCH] Update README.md --- AUTHORS.rst | 2 +- README.md | 29 +++++++++++++++++++++++++++-- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 8e59fa7..1a0ff28 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,7 +1,7 @@ Maintainer `````````` -- Amos Bastian `@amosbastian `_, +- Amos Bastian `@amosbastian `_, Contributors ```````````` diff --git a/README.md b/README.md index 68d0c50..82e0e6b 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,36 @@ The recommended way to install fpl is via ``pip``. pip install fpl +To install it directly from GitHub you can do the following: + + git clone git://github.com/amosbastian/fpl.git + +You can also install a [.tar file](https://github.com/requests/requests/tarball/master) +or [.zip file](https://github.com/requests/requests/tarball/master) + + $ curl -OL https://github.com/amosbastian/fpl/tarball/master + $ curl -OL https://github.com/amosbastian/fpl/zipball/master # Windows + +Once it has been downloaded you can easily install it using `pip`:: + + $ cd fpl + $ pip install . ## Contributing -Proper contributing guidelines will be added soon. +1. Fork the repository on GitHub. +2. Run the tests with `pytest tests/` to confirm they all pass on your system. + If the tests fail, then try and find out why this is happening. If you aren't + able to do this yourself, then don't hesitate to either create an issue on + GitHub, contact me on Discord or send an email to [amosbastian@gmail.com](mailto:amosbastian@gmail.com>). +3. Either create your feature and then write tests for it, or do this the other + way around. +4. Run all tests again with with `pytest tests/` to confirm that everything + still passes, including your newly added test(s). +5. Create a pull request for the main repository's ``master`` branch. + +For more information on how to contribute to **fpl** see [the contributing guide](https://fpl.readthedocs.io/en/latest/contributing/contributing.html). ## Documentation -Documentation and examples for `fpl` can be found at http://fpl.readthedocs.io/en/latest/. +Documentation and examples for **fpl** can be found at http://fpl.readthedocs.io/en/latest/.