Skip to content

Commit 727c18a

Browse files
authored
Update README.md
1 parent 55e3195 commit 727c18a

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ Feel free to submit an issue, or even a Pull Request (PR) with fixes or improvem
1010

1111
## Building
1212

13-
Note that the website is now automatically built and deployed with each push/merge into the main branch, using the github action .github/workflows/build-and-deploy.yml and the GitHub pages system for hosting the website.
13+
Note that the website is now automatically built and deployed with each push/merge into master branch, using the GitHub action [build-and-deploy.yml](https://github.com/777arc/PySDR/blob/master/.github/workflows/build-and-deploy.yml) and the GitHub pages system for hosting the actual textbook.
1414

15-
### Ubuntu
15+
For testing changes to the textbook locally, you can build using the following steps:
16+
17+
### Ubuntu/Debian
1618

1719
```bash
1820
sudo apt update
@@ -24,27 +26,26 @@ make html-nl
2426
make html-ukraine
2527
```
2628

27-
In _build there should be an index.html that represents the main page of the site
29+
In _build there should be an index.html that represents the main page of the English site
2830

2931
Note: on one machine I had to add `~/.local/bin` to PATH
3032

3133
### Windows
3234

33-
(this wont include the French version):
35+
To build the English version:
3436

3537
```
3638
sphinx-build -b html -D imgmath_latex="C:\Program Files\MiKTeX 2.9\miktex\bin\x64\latex.exe" . _build
3739
```
3840

3941
## Creating a PDF Export
4042

41-
Not fully working yet due to gifs
43+
Not fully working yet due to animated gifs, they all need to be removed for this to not error out:
4244

4345
```
4446
sudo apt-get install -y latexmk
4547
sphinx-build -b latex . _build/latex
4648
make latexpdf
47-
NEED TO REMOVE ALL GIFS FOR IT TO NOT ERROR OUT
4849
```
4950

5051
## Misc

0 commit comments

Comments
 (0)