BUILD.md 828 Bytes
Newer Older
Micah Lee's avatar
Micah Lee committed
1 2 3 4 5
# Build Instructions

## Install dependencies

```sh
6
sudo apt update
7
sudo apt install build-essential fakeroot python3-all python3-pyqt5 python3-stdeb gksu ikiwiki po4a
Micah Lee's avatar
Micah Lee committed
8 9 10 11 12
```

## To run during development

```sh
13 14 15 16
./dev_scripts/whiskers
./dev_scripts/whiskers-cli
```

17
## To build the documentation
18

Blue Nine's avatar
Blue Nine committed
19
To `.../install/guides` before buliding the .deb:
20 21

```sh
22
./dev_scripts/build-doc -rebuild
23 24
```

Blue Nine's avatar
Blue Nine committed
25
To a custom directory, like the following, for testing:
26 27

```sh
28
./dev_scripts/build-doc --set destdir="/usr/share/doc/tails/website/whiskers" -rebuild
29 30
```

31 32
## To build the Whiskers locale files

Blue Nine's avatar
Blue Nine committed
33 34
To `.../install/locale` before building the .deb:

35 36
```sh
for i in en es pt; do 
Blue Nine's avatar
Blue Nine committed
37
    mkdir -p install/locale/$i
38
    msgfmt --check locale/$i.po -o install/locale/$i/whiskers.mo;
39 40 41
done
```

42 43 44 45
## To build a package

```sh
./install/build_deb.sh
Micah Lee's avatar
Micah Lee committed
46
```