You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,14 @@ The following is a set of guidelines for contributing to the Genja Python packag
6
6
7
7
## Development environment
8
8
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.
Copy file name to clipboardExpand all lines: README.md
+11-30Lines changed: 11 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,23 +5,16 @@ Genja is a simple static website generator. It is a Python command line tool tha
5
5
Installation
6
6
------------
7
7
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:
9
9
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
19
12
```
20
13
21
14
Check the installed version from the command line:
22
15
23
-
```text
24
-
genja --version
16
+
```console
17
+
$ genja --version
25
18
```
26
19
27
20
## Usage
@@ -57,14 +50,14 @@ title = "My Website"
57
50
58
51
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.
59
52
60
-
```text
61
-
genja serve
53
+
```console
54
+
$ genja serve
62
55
```
63
56
64
57
Use the build command to build the website without running a local server.
65
58
66
-
```text
67
-
genja build
59
+
```console
60
+
$ genja build
68
61
```
69
62
70
63
## Examples
@@ -73,24 +66,12 @@ See the examples directory in this repository for projects that can be built wit
73
66
74
67
## Contributing
75
68
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.
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.
89
70
90
71
## Support
91
72
92
73
Support this project by using the **:heart: Sponsor** button at the top of this page. Thank you :smile:.
93
74
94
75
## License
95
76
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