diff --git a/README.md b/README.md index e053a9c4f..119f594c2 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,25 @@ Processor SDK Documentation in Sphinx ## Instructions to build the project on Ubuntu +### Clone the Git Repo + + $ git clone https://github.com/TexasInstruments/processor-sdk-doc.git + ### Install tools on Ubuntu Use the following command in a python virtual environment for a known working config: - # python3 -m pip install -r requirements.txt + $ cd processor-sdk-doc + $ python3 -m pip install -r requirements.txt + +> [!WARNING] +> 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 +> bundled `pip` version. OR you can use a docker container like the following: - [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc) -### Clone the Git Repo - - $ git clone https://github.com/TexasInstruments/processor-sdk-doc.git - ### Build on Ubuntu To build the documentation a DEVFAMILY and OS must be specified as either an @@ -51,15 +56,15 @@ Example build commands: - Build linux documentation for AM335X - $ make DEVFAMILY=AM335X OS=linux + $ make DEVFAMILY=AM335X OS=linux - Build android documentation for AM62X - $ make DEVFAMILY=AM62X OS=android + $ make DEVFAMILY=AM62X OS=android - Build debian documentation for AM62PX - $ make DEVFAMILY=AM62PX OS=debian + $ make DEVFAMILY=AM62PX OS=debian ### HTML Page Output @@ -67,7 +72,7 @@ Open the index page in a web browser linux: ./build/processor-sdk-linux-/esd/docs/[version]/index.html android: ./build/processor-sdk-android-/esd/docs/[version]/index.html - debian: ./build/processor-sdk-debian-/esd/docs/[version]/index.html + debian: ./build/processor-sdk-debian-/esd/docs/[version]/index.html ## Live Preview on GitHub Pages