Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,45 +50,59 @@ If you wish to build the documents on the desktop, you can do as follows.

Setup Linux system requirements:

$ sudo apt update
$ sudo apt install cmake doxygen libhugetlbfs-dev libsysfs-dev
$ sudo apt install python3-pip git
```shell
sudo apt update
sudo apt install cmake doxygen libhugetlbfs-dev libsysfs-dev
sudo apt install python3-pip git
```

Setup the document repository on your machine:

$ git clone --recurse https://github.com/openAMP/openamp-docs.git
$ cd openamp-docs
$ git submodule update
```shell
git clone --recurse https://github.com/openAMP/openamp-docs.git
cd openamp-docs
git submodule update
```

### Building using virtual environment

When possible it is recommended to use a
[Python virtual environment](https://docs.python.org/3/library/venv.html)
(Python 3.3 and higher, required by Ubuntu 24.04 or higher):

$ python3 -m venv .venv
$ . .venv/bin/activate
```shell
python3 -m venv .venv
. .venv/bin/activate
```

Install pip modules

$ python3 -m pip install -r requirements.txt
```shell
python3 -m pip install -r requirements.txt
```

#### Activate the virtual environment for build session

When using a virtual environment activate it before each build session:

$ cd openamp-docs
$ . .venv/bin/activate
```shell
cd openamp-docs
. .venv/bin/activate
```

### Build and view the html documents

$ make html
$ xdg-open _build/html/index.html
```shell
make html
xdg-open _build/html/index.html
```

### Build and view the pdf

$ make pdf
$ xdg-open _build/pdf/openamppdf.pdf
```shell
make pdf
xdg-open _build/pdf/openamppdf.pdf
```

Notes:
* The build process currently produces many warnings
Expand Down