Skip to content

Commit 8477d8b

Browse files
committed
Update README with new instructions
1 parent 4b6a0f8 commit 8477d8b

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,24 @@ This repo holds the website content for https://rst2pdf.github.io.
66

77
To contribute to this repo, make sure that your master branch is up to date and create a new branch from there.
88

9-
To run the project locally and check your work as you go along, try [these instructions from GitHub](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), which can be summarised as:
9+
The website content is in `source/`.
1010

11-
$ gem install bundler
12-
$ bundle install
13-
$ bundle exec jekyll serve
11+
### Develop locally
12+
13+
This Python-based project uses [uv](https://docs.astral.sh/uv/) and [make](https://www.gnu.org/software/make/), so install those first if you don't have them already.
14+
15+
1. Install dependencies
16+
17+
```
18+
uv sync
19+
```
20+
21+
2. Build the site
22+
23+
```
24+
make html
25+
```
26+
27+
The output files are in the `build/` directory as HTML.
28+
29+
3. (optional) Preview the files with `python -m http.server`.

0 commit comments

Comments
 (0)