Skip to content

Commit 7ad1c60

Browse files
Merge pull request #3816 from raspberrypi/lurch-patch-1
Add additional doxygen-related dependencies to README.md
2 parents a25d6ad + 1df2063 commit 7ad1c60

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Instructions on how to checkout the `documentation` repo, and then install the t
1010

1111
### Checking out the Repository
1212

13-
Install `git` if you don't already have it, and check out the `documentation` repo as follows,
13+
Install `git` if you don't already have it, and check out the `documentation` repo as follows:
1414
```
1515
$ git clone https://github.com/raspberrypi/documentation.git
1616
$ cd documentation
@@ -22,13 +22,13 @@ $ cd documentation
2222

2323
This works on both regular Debian or Ubuntu Linux — and has been tested in a minimal Docker container — and also under Raspberry Pi OS if you are working from a Raspberry Pi.
2424

25-
You can install the necessary dependencies on Linux as follows,
25+
You can install the necessary dependencies on Linux as follows:
2626

2727
```
2828
$ sudo apt install -y ruby ruby-dev python3 python3-pip make ninja-build
2929
```
3030

31-
then add these lines to the bottom of your `$HOME/.bashrc`,
31+
then add these lines to the bottom of your `$HOME/.bashrc`:
3232
```
3333
export GEM_HOME="$(ruby -e 'puts Gem.user_dir')"
3434
export PATH="$PATH:$GEM_HOME/bin"
@@ -157,14 +157,20 @@ $ make clean
157157

158158
### Building with Doxygen
159159

160-
If you want to build the Pico C SDK Doxygen documentation alongside the main documentation site you can do so with,
160+
If you want to build the Pico C SDK Doxygen documentation alongside the main documentation site you will need to install some additional dependencies:
161+
162+
```
163+
$ sudo apt install -y cmake gcc-arm-none-eabi doxygen graphviz
164+
```
165+
166+
and then you can build the documentation with:
161167

162168
```
163169
$ make build_doxygen_adoc
164170
$ make
165171
```
166172

167-
and clean up afterwards by using,
173+
You clean up afterwards by using:
168174

169175
```
170176
$ make clean_everything

0 commit comments

Comments
 (0)