summaryrefslogtreecommitdiffstats
path: root/README.md
blob: f7bf5caaf5c992af4d6832885bc093c19e3340cd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# hack-gpon.org


Based on just-the-docs theme:
- [GitHub](https://github.com/just-the-docs/just-the-docs) 
- [Demo](https://just-the-docs.github.io/just-the-docs/)


if you want to contribute there is something to be done:

- a unique template for all sticks
- how to use arduino as TTL/UART adapter
- theoretical information on GPON
- absent stick information
- quick start
- absent and new ont

##  How to build
This website uses typescript, so remember to:

- Install node (20)
- Run npm ci to install all relevant typescript packages
- Run npm run build to transpile ts to js

Alternatively, you can just run:
`docker-compose up -d typescript` which will build all the required typescript files for you