From 065aa1d913afef5c194b9991c8cd30cb373d3821 Mon Sep 17 00:00:00 2001 From: Leonardo Covarrubias Date: Sat, 22 Jun 2024 16:59:37 -0400 Subject: [PATCH 1/4] docs: update installation.rst --- docs/installation.rst | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 1b5304b..ac73285 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,7 +3,7 @@ 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 platform. On many operating systems Python is installed by default, but this can be a very old @@ -14,23 +14,25 @@ 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:: -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.:: + pip install cedar-solve - pip install git+https://github.com/smroid/cedar-solve.git +You can test that it works by invoking the database generator command:: -You can test that it works by running the example provided in the GitHub repo. + tetra3-gen-db --help 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 Releasess `_ +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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -97,17 +99,12 @@ 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 `_. From d592f4996c8ca96658624f9bc2ce0449602d31b9 Mon Sep 17 00:00:00 2001 From: Leonardo Covarrubias Date: Sat, 22 Jun 2024 17:11:11 -0400 Subject: [PATCH 2/4] docs: mention discord server --- docs/installation.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index ac73285..c3fac33 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -108,3 +108,5 @@ You can run the automated test suite with this command (from the repository root If problems arise ----------------- Please get in touch by `filing an issue `_. + +You can also join the `Cedar Discord `_ server. From 510d5bf409ef65648d6c85eee29f81c244f80fea Mon Sep 17 00:00:00 2001 From: Leonardo Covarrubias Date: Sat, 22 Jun 2024 17:16:02 -0400 Subject: [PATCH 3/4] docs: mention example --- docs/installation.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index c3fac33..8de2674 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -13,7 +13,7 @@ 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 available on PyPI (the Python Package Index). You may install it by:: pip install cedar-solve @@ -22,6 +22,10 @@ You can test that it works by invoking the database generator command:: tetra3-gen-db --help +Example +^^^^^^^ +An `example `_ is available on the GitHub repository showing some ways of working with the library. + Manually download source code ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You have two options to manually download the source code. From 2600409bea5185dad3188799f2e8b3d253f874e9 Mon Sep 17 00:00:00 2001 From: Leonardo Covarrubias Date: Sat, 22 Jun 2024 17:41:03 -0400 Subject: [PATCH 4/4] docs: spelling --- docs/installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 8de2674..294e1bf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,7 +5,7 @@ Getting Python -------------- 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 @@ -30,7 +30,7 @@ Manually download source code ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You have two options to manually download the source code. -1. Download the release of your choice by going to `GitHub Releasess `_ +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 @@ -48,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