Skip to content

Commit 8a030f8

Browse files
jonaswood01cshilwant
authored andcommitted
docs(README): Update README commands
Moves git clone section above install tools. Updates two install tool versions that were broken. Signed-off-by: Jonas Wood <[email protected]>
1 parent 88dacbb commit 8a030f8

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,25 @@ Processor SDK Documentation in Sphinx
33

44
## Instructions to build the project on Ubuntu
55

6+
### Clone the Git Repo
7+
8+
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
9+
610
### Install tools on Ubuntu
711

812
Use the following command in a python virtual environment for a known working
913
config:
1014

11-
# python3 -m pip install -r requirements.txt
15+
$ cd processor-sdk-doc
16+
$ python3 -m pip install -r requirements.txt
17+
18+
> [!WARNING]
19+
> This is supported using Python v3.12+. If using an older Python version, some package versions in `requirements.txt` may not be compatible, possibly due to an older
20+
> bundled `pip` version.
1221
1322
OR you can use a docker container like the following:
1423
- [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc)
1524

16-
### Clone the Git Repo
17-
18-
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
19-
2025
### Build on Ubuntu
2126

2227
To build the documentation a DEVFAMILY and OS must be specified as either an
@@ -51,23 +56,23 @@ Example build commands:
5156

5257
- Build linux documentation for AM335X
5358

54-
$ make DEVFAMILY=AM335X OS=linux
59+
$ make DEVFAMILY=AM335X OS=linux
5560

5661
- Build android documentation for AM62X
5762

58-
$ make DEVFAMILY=AM62X OS=android
63+
$ make DEVFAMILY=AM62X OS=android
5964

6065
- Build debian documentation for AM62PX
6166

62-
$ make DEVFAMILY=AM62PX OS=debian
67+
$ make DEVFAMILY=AM62PX OS=debian
6368

6469
### HTML Page Output
6570

6671
Open the index page in a web browser
6772

6873
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
6974
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
70-
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
75+
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
7176

7277
## Live Preview on GitHub Pages
7378

0 commit comments

Comments
 (0)