Skip to content

Commit

Permalink
docs: actual run from source tutorial (#426)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Aleksandr Karpov <alex.nsk.karpov@gmail.com>
  • Loading branch information
alex-karpov and Aleksandr Karpov committed Dec 29, 2023
1 parent 06102cc commit 5559ea6
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 3 deletions.
33 changes: 31 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,47 @@

## Get Started

### Preparation

SportOrg runs on Python 3.8 for compatibility with Windows 7. Latest Python 3.8 release with binary installers is [Python 3.8.10](https://www.python.org/downloads/release/python-3810/).

During development, the [poetry](https://python-poetry.org/) and [poe](https://poethepoet.natn.io/) tools are used. The preferred method for installing these utilities is [pipx](https://pipx.pypa.io/).

It may be necessary to restart the terminal window during the installation process to update the `PATH` environment variable.

```
python3.8 -m venv .venv
pip install pipx
pipx ensurepath
pipx install poetry
pipx install poethepoet
```

### Create Virtual Environment

Get pysport project.

```
git clone https://github.com/sportorg/pysport.git
cd pysport
```

If multiple versions of Python are installed, it is necessary to specify the path to the Python 3.8 executable file.

```
poetry env use /full/path/to/python3.8
```

Install requirements.

```
pip install poetry
poetry install
poetry install -E win # for Windows
```

Add `DEBUG=True` to `.env` file or `cp .env.example .env`

### Run SportOrg

```
poe run
```
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@

Sportorg is a comprehensive software solution developed in Python that streamlines the organization and execution of orienteering competitions. Orienteering is a sport that challenges participants to navigate through unfamiliar terrain using only a map and compass, testing their navigation and decision-making skills. This software aims to enhance the experience for both event organizers and participants by providing a user-friendly platform to manage various aspects of orienteering competitions.

## Run from source

See [CONTRIBUTING.md](CONTRIBUTING.md)

## Screenshots

![Mainwindow sportorg](img/mainwindow.png)

![Dialogedit sportorg](img/dialogedit.png)

![Bibprintout sportorg](img/bibprintout.png)
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,7 @@ cmd = "python -m sportorg.language"

[tool.poe.tasks.run]
help = "Run"
cmd = "python SportOrg.pyw"
sequence = [
{ref = "generate-mo"},
{cmd = "python SportOrg.pyw"}
]

0 comments on commit 5559ea6

Please sign in to comment.