Skip to content

Commit

Permalink
Update the documentation on installing SkoolKit
Browse files Browse the repository at this point in the history
  • Loading branch information
skoolkid committed Jul 15, 2023
1 parent a6cc05f commit f15dc7e
Showing 1 changed file with 6 additions and 34 deletions.
40 changes: 6 additions & 34 deletions sphinx/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,17 @@ Installation
There are various ways to install the latest stable release of SkoolKit:

* from the zip archive or tarball available at `skoolkit.ca`_
* from the zip archive or tarball available at `GitHub`_
* from `PyPI`_ by using `pip`_
* from the `PPA`_ for Ubuntu
* from the `copr repo`_ for Fedora

If you choose the zip archive or tarball, note that SkoolKit can be used
wherever it is unpacked: it does not need to be installed in any particular
location. However, if you would like to install SkoolKit as a Python package,
you can do so by following the instructions below.
location.

.. _skoolkit.ca: https://skoolkit.ca/skoolkit/
.. _GitHub: https://github.com/skoolkid/skoolkit/releases
.. _PyPI: https://pypi.org/project/skoolkit/
.. _pip: https://pip.pypa.io/
.. _PPA: https://launchpad.net/~rjdymond/+archive/ppa
.. _copr repo: https://copr.fedorainfracloud.org/coprs/rjdymond/SkoolKit/

Windows
^^^^^^^
To install SkoolKit as a Python package on Windows, open a command prompt,
change to the directory where SkoolKit was unpacked, and run the following
command::

> python3 -m pip install .

This will install the SkoolKit command scripts in `C:\\Python39\\Scripts`
(assuming you have installed Python in `C:\\Python39`), which means you can
run them from anywhere (assuming you have added `C:\\Python39\\Scripts` to the
``Path`` environment variable).

Linux/\*BSD
^^^^^^^^^^^
To install SkoolKit as a Python package on Linux/\*BSD, open a terminal window,
change to the directory where SkoolKit was unpacked, and run the following
command as root::

# python3 -m pip install .

This will install the SkoolKit command scripts in `/usr/local/bin` (or some
other suitable location in your ``PATH``), which means you can run them from
anywhere.

Linux/\*BSD v. Windows command line
-----------------------------------
Expand All @@ -61,6 +33,6 @@ dollar sign (``$``), like this::
$ some-script.py some arguments

On Windows, and on Linux/\*BSD if SkoolKit has been installed as a Python
package (see above), the commands may be entered exactly as they are shown. On
Linux/\*BSD, use a dot-slash prefix (e.g. ``./some-script.py``) if the script
is being run from the current working directory.
package (using 'pip'), the commands may be entered exactly as they are shown.
On Linux/\*BSD, use a dot-slash prefix (e.g. ``./some-script.py``) if the
script is being run from the current working directory.

0 comments on commit f15dc7e

Please sign in to comment.