Skip to content

Commit

Permalink
Little more clear installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
facelessuser committed Jan 2, 2024
1 parent 29f4fa3 commit 8a61b82
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/src/markdown/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,42 +18,42 @@ installation can be done quickly and easily through `pip`. Some platforms, like
hoops that you must jump through. Additionally, wxPython, the GUI library that Rummage depends on, may sometimes have
support lagging for the latest Python version.

Install:
In general, it is always recommended to try and install `wxpython` first and make sure it is properly available
before installing Rummage. The wxPython installation may be more complicated depending on the platform. But in general,
for non-Linux systems, the following steps are usually sufficient.

Make sure wxPython is installed first. It is important to first ensure wxPython can be installed for your platform and
specific Python version first.

```console
$ pip install rummage
$ pip install wxpython
```

Install with optional modules.
Install Rummage:

```console
$ pip install rummage[extras]
$ pip install rummage
```

Upgrade:
Install Rummage with optional modules.

```console
$ pip install --upgrade rummage
$ pip install rummage[extras]
```

### Windows

On systems like Windows, installation is pretty straight forward as wheels are provided for all packages in `pip`.
Support for the latest Python version may not always be available as the development cycle for wxPython can take a bit
to catch up.

Simply using `pip` to install is sufficient.
Upgrade Rummage:

```console
$ pip install rummage
$ pip install --upgrade rummage
```

### MacOS
### Windows and macOS

In recent years, wheels are usually available for wxPython on macOS. Support for the latest Python version may not
always be available as the development cycle for wxPython can take a bit to catch up.
On Windows, installation is pretty straight forward as wheels are provided for all packages in `pip`. In recent years,
macOS installation also usually has wheels available as well. Support for the latest Python version may not always be
available as the development cycle for wxPython can take a bit to catch up.

Usually, you can just use `pip` to install:
Simply using `pip` to install is sufficient.

```console
$ pip install rummage
Expand Down

0 comments on commit 8a61b82

Please sign in to comment.