Skip to content

Commit

Permalink
Additional readme boilerplate
Browse files Browse the repository at this point in the history
Replaced pyenv with setup-python in GitHub workflow
  • Loading branch information
sonotley committed Jun 30, 2023
1 parent debb55c commit 5a6641b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"python_max_version": "3.11",
"__min_ver": "{{ cookiecutter.python_min_version.split('.')[1] }}",
"__max_ver": "{{ cookiecutter.python_max_version.split('.')[1] }}",
"__python_versions": "3.{{ range(cookiecutter.__min_ver | int, (cookiecutter.__max_ver | int) + 1) | join(', 3.') }}",
"__python_versions": "|\n 3.{{ range(cookiecutter.__min_ver | int, (cookiecutter.__max_ver | int) + 1) | join('\\n 3.') }}",
"__tox_envs": "py{{ range(cookiecutter.__min_ver | int, (cookiecutter.__max_ver | int) + 1) | join(', py3') }}",
"config_file_type": ["none", "yaml", "toml", "ini"],
"initialise_poetry": true,
Expand Down
7 changes: 3 additions & 4 deletions {{ cookiecutter.project_slug }}/.github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ jobs:
permissions:
contents: write
steps:
- name: setup pyenv
uses: "gabrielfalcao/pyenv-action@v11"
- name: Setup Python interpreters
uses: actions/setup-python@v4
with:
default: {{ cookiecutter.python_max_version }}
versions: {{ cookiecutter.__python_versions }}
python-version: {{ cookiecutter.__python_versions }}
- name: Add poetry
uses: abatilo/actions-poetry@v2
- uses: actions/checkout@v3
Expand Down
4 changes: 2 additions & 2 deletions {{ cookiecutter.project_slug }}/dist/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
> This installation method requires Python {{ cookiecutter.python_min_version }}+ to be installed and on the PATH. It also requires internet connectivity.
Simply run the installation script for your operating system. Optionally you may supply the installation location as an argument.
For example `install_on_windows.cmd C:\imcity`. Do not add a trailing slash.
For example `install_on_windows.cmd C:\my_snoap_apps`. Do not add a trailing slash.

If installed without specifying a location the default locations are:

Windows: `C:`

Debian: `/opt`
Linux: `/opt`

The installer will create a directory `{{ cookiecutter.project_slug }}` in the chosen location. This will contain

Expand Down
15 changes: 14 additions & 1 deletion {{ cookiecutter.project_slug }}/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,17 @@

{{ cookiecutter.description }}

> This is the project-level readme that will appear on github etc
## How do I use it?

- Download the latest build [here](/releases/latest).
- Follow the installation instructions included with the release, or read them [here](/dist/readme.md).
- Follow the usage instructions installed with the app, or read them [here](/dist/readme_for_app.md).

## How do I develop it?

- Install [poetry](https://python-poetry.org/)
- Clone this repo
- Run `poetry install` in the project directory
- Consider checking out [cookiecutter-snoap](https://github.com/sonotley/cookiecutter-snoap)
which was used to create this project for
instructions on some of the boilerplate scripts etc.

0 comments on commit 5a6641b

Please sign in to comment.