File: README.md

package info (click to toggle)
codelite 17.0.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 136,244 kB
  • sloc: cpp: 491,547; ansic: 280,393; php: 10,259; sh: 8,930; lisp: 7,664; vhdl: 6,518; python: 6,020; lex: 4,920; yacc: 3,123; perl: 2,385; javascript: 1,715; cs: 1,193; xml: 1,110; makefile: 804; cobol: 741; sql: 709; ruby: 620; f90: 566; ada: 534; asm: 464; fortran: 350; objc: 289; tcl: 258; java: 157; erlang: 61; pascal: 51; ml: 49; awk: 44; haskell: 36
file content (47 lines) | stat: -rw-r--r-- 873 bytes parent folder | download | duplicates (3) 
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
## To build the docs:

Install the following

- python3
- pip3
- install mkdocs + extensions
- If you are under MSYS2, make sure to install libcrypt-devel & python3:

# MSYS2:

```bash
pacman -S libcrypt-devel
pacman -S python3
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py
echo 'export PATH=/home/eran/.local/bin;$PATH' >> ~/.bashrc
. ~/.bashrc
```

# Ubuntu / Debian:

```bash
# make sure we got curl installed
sudo apt-get install curl
# install pip3
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py
echo 'export PATH=$HOME/.local/bin;$PATH' >> ~/.bashrc
. ~/.bashrc
sudo apt-get install libpython2-dev
```

```bash
pip3 install mkdocs
pip3 install pymdown-extensions
pip3 install mkdocs-material
```

To start the local webserver:

```bash
mkdocs serve
```

To view the docs, open the URL: http://127.0.0.1:8000/