Skip to content

Commit 476777b

Browse files
committed
Move README to rst format
1 parent 8477d8b commit 476777b

2 files changed

Lines changed: 35 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎README.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Website for rst2pdf
2+
===================
3+
4+
This repo holds the website content for https://rst2pdf.github.io.
5+
6+
Contributing
7+
------------
8+
9+
To contribute to this repo, make sure that your master branch is up to
10+
date and create a new branch from there.
11+
12+
The website content is in ``source/``.
13+
14+
Develop locally
15+
~~~~~~~~~~~~~~~
16+
17+
This Python-based project uses `uv <https://docs.astral.sh/uv/>`__ and
18+
`make <https://www.gnu.org/software/make/>`__, so install those first if
19+
you don’t have them already.
20+
21+
1. Install dependencies
22+
23+
::
24+
25+
uv sync
26+
27+
2. Build the site
28+
29+
::
30+
31+
make html
32+
33+
The output files are in the ``build/`` directory as HTML.
34+
35+
3. (optional) Preview the files with ``python -m http.server``.

0 commit comments

Comments
 (0)