Skip to content

Commit 0b3c4c2

Browse files
committed
Update text for uv tool
1 parent 0ea01fb commit 0b3c4c2

File tree

2 files changed

+14
-37
lines changed

2 files changed

+14
-37
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,14 @@ The following is a set of guidelines for contributing to the Genja Python packag
66

77
## Development environment
88

9-
Clone this repository and use the conda environment file to create a Python environment for developing Genja. See the comments in the file for more details. The conda environment uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting along with [pytest](https://docs.pytest.org) for running tests. Genja is installed in editable mode within the environment.
9+
Clone this repository and use the [uv tool](https://docs.astral.sh/uv/) for Python and package management. The environment created by uv uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting along with [pytest](https://docs.pytest.org) for running tests. Genja is installed in editable mode within the environment.
1010

1111
```bash
1212
# Clone this project
1313
git clone https://github.com/wigging/genja.git
1414

15-
# Create the conda environment
16-
cd genja
17-
conda env create --file environment.yml
18-
19-
# Activate the conda environment
20-
conda activate genja
15+
# Sync the project environment
16+
uv sync
2117
```
2218

2319
## Code style, linting, and formatting

README.md

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,16 @@ Genja is a simple static website generator. It is a Python command line tool tha
55
Installation
66
------------
77

8-
Download and install Python from [python.org](https://www.python.org) or from [Anaconda](https://www.anaconda.com). After installing Python, create and activate a virtual environment as shown below:
8+
The [uv tool](https://docs.astral.sh/uv/) is recommended for Python installation and package management. After installing uv, use the tool command to install Genja as a command line tool on your computer:
99

10-
```text
11-
python -m venv .venv
12-
source .venv/bin/activate
13-
```
14-
15-
Next, install Genja from [PyPI](https://pypi.org) using the following command:
16-
17-
```text
18-
pip install genja
10+
```console
11+
$ uv tool install genja
1912
```
2013

2114
Check the installed version from the command line:
2215

23-
```text
24-
genja --version
16+
```console
17+
$ genja --version
2518
```
2619

2720
## Usage
@@ -57,14 +50,14 @@ title = "My Website"
5750

5851
Use the serve command to build the website and start a local server. This will automatically open the default web browser to view the website. The website will automatically reload when changes are saved to the Markdown files.
5952

60-
```text
61-
genja serve
53+
```console
54+
$ genja serve
6255
```
6356

6457
Use the build command to build the website without running a local server.
6558

66-
```text
67-
genja build
59+
```console
60+
$ genja build
6861
```
6962

7063
## Examples
@@ -73,24 +66,12 @@ See the examples directory in this repository for projects that can be built wit
7366

7467
## Contributing
7568

76-
Clone this repository and use the conda environment file to create a Python environment for developing Genja. This environment uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting along with [pytest](https://docs.pytest.org) for running tests. Genja is installed in editable mode within the environment.
77-
78-
```bash
79-
# Clone this project
80-
git clone https://github.com/wigging/genja.git
81-
82-
# Create the conda environment
83-
cd genja
84-
conda env create --file environment.yml
85-
86-
# Activate the conda environment
87-
conda activate genja
88-
```
69+
Clone this repository and use the [uv tool](https://docs.astral.sh/uv/) to create a Python environment for developing Genja. This environment uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting along with [pytest](https://docs.pytest.org) for running tests. Genja is installed in editable mode within the environment. See the [CONTRIBUTING](CONTRIBUTING.md) document for more details.
8970

9071
## Support
9172

9273
Support this project by using the **:heart: Sponsor** button at the top of this page. Thank you :smile:.
9374

9475
## License
9576

96-
This project is licensed under the terms of the MIT license. See [here](LICENSE.md) for the license text.
77+
This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE.md) document for the license text.

0 commit comments

Comments
 (0)