diff --git a/docs/installation.rst b/docs/installation.rst index 1b5304b..294e1bf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,9 +3,9 @@ Installation Getting Python -------------- -Cedar-solve is written for Python 3.7 or later (and therefore runs on almost any platform) and should +Cedar-solve is written for Python 3.8 or later (and therefore runs on almost any platform) and should work with most modern Python 3 installations. There are many ways to get Python on your system. -Most easily, by going to `the python webiste `_ and selecting your +Most easily, by going to `the python website `_ and selecting your platform. On many operating systems Python is installed by default, but this can be a very old version (often 2.7). Check if you have something installed by running ``python --version`` in a command prompt or terminal window. You can also check ``python3 --version`` as it is sometimes @@ -13,24 +13,30 @@ installed under this name. In the latter case, use ``python3`` and ``pip3`` in p and ``pip`` in these instructions. Getting Cedar-solve --------------- -Cedar-solve is not available on PyPI (the Python Package Index) yet. Instead you need to provide -a link to or download the GitHub source code. +------------------- +Cedar-solve is available on PyPI (the Python Package Index). You may install it by:: + + pip install cedar-solve -Use PIP to download and install -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The easiest method is to let PIP download from GitHub and install. This will set up all -dependencies and make the package usable from anywhere.:: +You can test that it works by invoking the database generator command:: - pip install git+https://github.com/smroid/cedar-solve.git + tetra3-gen-db --help -You can test that it works by running the example provided in the GitHub repo. +Example +^^^^^^^ +An `example `_ is available on the GitHub repository showing some ways of working with the library. Manually download source code ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Go to `the GitHub repository `_, click `Clone or Download` and -`Download ZIP` and extract the cedar-solve directory to where you want to use it. You can put this -directly in your Python project as a module and use, or see below for how to install it. +You have two options to manually download the source code. + +1. Download the release of your choice by going to `GitHub Releases `_ +and downloading the `Source Code` archive in your preferred format. + +2. Download the latest code from the `GitHub repository `_. Click `Clone or Download` and +`Download ZIP` + +Afterward you can extract the cedar-solve directory to where you want to use it. Use git to download and contribute to source code ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -42,7 +48,7 @@ GitHib repository:: git clone "https://github.com/smroid/cedar-solve.git" -You should see the cedar-solve directory created for you with all neccessary files. Check the status of +You should see the cedar-solve directory created for you with all necessary files. Check the status of your repository by typing:: cd cedar-solve @@ -97,17 +103,14 @@ which should print out the solutions for the included test images. You can run the automated test suite with this command (from the repository root dir):: + # run all tests pytest # skip slow tests pytest -m "not slow" -Using cedar-solve as a module in your repository - -A specific branch named `no_big_files` is available for practical inclusion as a git submodule -in your own repository. This does not include the default database and example images, making -it less than 1 MB. For a specific application you probably want a custom database anyway. - If problems arise ----------------- Please get in touch by `filing an issue `_. + +You can also join the `Cedar Discord `_ server.