Skip to content

Commit 922fe9f

Browse files
deno832Pesa
authored andcommitted
Improve README.md
Closes #8
1 parent dd04290 commit 922fe9f

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,42 @@ An introductory website on Named Data Networking (NDN).
44

55
Link: [101.named-data.net](https://101.named-data.net/)
66

7-
## Local build
7+
## General Information
88

9-
Install dependencies:
9+
This documentation website is made using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). The website structure can be found in [`mkdocs.yml`](mkdocs.yml). Build dependencies are managed with [Poetry](https://python-poetry.org/).
10+
11+
## Local Build
12+
13+
First you should install Poetry for dependency management. We recommend using [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/) to install Poetry in a dedicated virtual environment. For example, you can install Poetry by running:
1014

1115
```shell
16+
# Option 1: install via pipx
1217
pipx install poetry
18+
19+
# Option 2: install via uv
20+
uv tool install poetry
21+
```
22+
23+
After Poetry is installed, navigate to the project directory (i.e., ndn-101) and run the command below to install the required build dependencies:
24+
25+
```shell
1326
poetry install
1427
```
1528

16-
Live preview:
29+
To start a live preview on your machine, you can run:
1730

1831
```shell
1932
poetry run mkdocs serve
2033
```
34+
35+
After running this command, the MkDocs development server should start on your local machine (default port number is 8000).
36+
37+
To build static web pages, use this command:
38+
39+
```shell
40+
poetry run mkdocs build
41+
```
42+
43+
## Contributing
44+
45+
You can contribute to the NDN 101 website by submitting a pull request on GitHub.

0 commit comments

Comments
 (0)