Skip to content

Commit

Permalink
Update installing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
antorenge committed Sep 10, 2017
1 parent 148f2c2 commit d4ded08
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 53 deletions.
35 changes: 7 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,36 +30,14 @@ Prerequisites
Installing
~~~~~~~~~~

1. Fetch the latest copy of the project from github
To install Kool from PyPI, run::
$ python install kool

::

git clone https://github.com/edasi/kool.git

2. Setup a virtual environment

::

python3 -m venv kool-env

On Windows, run:

::

kool-env\Scripts\activate.bat

On Unix or MacOS, run:

::

source kool-env/bin/activate
If you prefer to install from source, download the latest version from Releases_. Thereafter, extract and run::

3. Install requirements

::
$ python setup.py install

pip install -U pip
pip install -r requirements.txt

Code Examples
~~~~~~~~~~~~~
Expand Down Expand Up @@ -163,4 +141,5 @@ License <https://github.com/edasi/kool/blob/master/LICENSE>`__
.. |codecov| image:: https://codecov.io/gh/edasi/kool/branch/master/graph/badge.svg
:target: https://codecov.io/gh/edasi/kool
.. |Documentation Status| image:: https://readthedocs.org/projects/kool-docs/badge/?version=latest
:target: http://kool-docs.readthedocs.io/en/latest/?badge=latest
:target: http://kool-docs.readthedocs.io/en/latest/?badge=latest
.. _Releases: https://github.com/edasi/kool/releases
27 changes: 2 additions & 25 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,10 @@ To install Kool from PyPI, run::
$ python install kool

If you prefer to install from source, download the latest version from GitHub_. Thereafter, extract and run::
If you prefer to install from source, download the latest version from Releases_. Thereafter, extract and run::

$ python setup.py install

Alternatively, if you prefer to manually install.

1. Fetch the latest version from github::

$ git clone https://github.com/edasi/kool.git

2. Setup a virtual environment::

$ python3 -m venv kool-env

On Windows, run:

$ kool-env\Scripts\activate.bat

On Unix or MacOS, run:

$ source kool-env/bin/activate

3. Install requirements::

$ pip install -U pip
$ pip install -r requirements.txt


Basic Usage
-----------
Expand Down Expand Up @@ -107,4 +84,4 @@ To delete an existing record:
>>>

.. References
.. _GitHub: https://github.com/edasi/kool
.. _Releases: https://github.com/edasi/kool/releases

0 comments on commit d4ded08

Please sign in to comment.