Skip to content

Commit 14ca7e4

Browse files
committed
docs(readme): simplify the readme and example make
At this point we should drive users to the container properly. That gives them access to almost all of the CI tools and ensures the output they generate will match what we expect. Advanced users can still parse the requirements.txt if they want. Also, add an example make command using the container to the top of the build guide since that is one of the more popular things I need to remind people about. Signed-off-by: Randolph Sapp <rs@ti.com>
1 parent 0ac1c54 commit 14ca7e4

File tree

1 file changed

+82
-67
lines changed

1 file changed

+82
-67
lines changed

README.md

Lines changed: 82 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,110 @@
1-
Processor SDK Documentation in Sphinx
2-
=====================================
1+
# Processor software development kit documentation
32

4-
## Instructions to build the project on Ubuntu
3+
This repository holds the documentation for the Texas Instruments Processor
4+
Software Development Kit (PSDK). It currently uses Sphinx and reStructuredText.
5+
There are some light plugins and a custom configuration tool to handle platform
6+
specific values.
57

6-
### Clone the Git Repo
8+
## Build guide
79

8-
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
10+
If you know what you are doing and just need a command:
911

10-
### Install tools on Ubuntu
12+
```
13+
docker run -it --rm -v "$PWD":/build ghcr.io/texasinstruments/processor-sdk-doc:latest make DEVFAMILY=AM62X OS=linux
14+
```
1115

12-
Use the following command in a python virtual environment for a known working
13-
config:
16+
If you have any questions about the preceding command, see the following
17+
sections.
1418

15-
$ cd processor-sdk-doc
16-
$ python3 -m pip install -r requirements.txt
19+
### Clone the repository
1720

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.
21+
```
22+
git clone https://github.com/TexasInstruments/processor-sdk-doc.git
23+
```
2124

22-
OR you can use a docker container like the following:
23-
- [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc)
25+
### Start the container
2426

25-
### Build on Ubuntu
27+
A lightweight container with all required dependencies is available on the
28+
GitHub container registry. The source code to build this container is available
29+
under the [`docker/`](docker/) subdirectory.
2630

27-
To build the documentation a DEVFAMILY and OS must be specified as either an
28-
argument to `make` or set as environment variables prior to execution of `make`.
31+
To start the container, issue the following at the root of the project.
2932

30-
DEVFAMILY represents the Device Family. Possible values correspond to the names
31-
of directories listed under `configs/`. For example:
33+
```
34+
docker run -it --rm -v "$PWD":/build ghcr.io/texasinstruments/processor-sdk-doc:latest
35+
```
3236

33-
* "AM335X" (representing AM335X family)
34-
* "AM437X" (representing AM437X family)
35-
* "AM57X" (representing AM57X family)
36-
* "AM64X" (representing AM64X family)
37-
* "AM62X" (representing AM62X family)
38-
* "AM62AX" (representing AM62AX family)
39-
* "AM62PX" (representing AM62PX family)
40-
* "AM62LX" (representing AM62L family)
41-
* "AM62DX" (representing AM62D family)
42-
* "AM65X" (representing AM65X family)
43-
* "DRA821A" (representing DRA821A)
44-
* "J721E" (representing Jacinto 7 ES)
45-
* "J7200" (representing Jacinto 7 VCL)
46-
* "J721S2" (representing Jacinto 7 AEP)
47-
* "J784S4" (representing Jacinto 7 AHP)
48-
* "J722S" (representing Jacinto 7 AEN)
37+
### Issue make
4938

50-
OS represents the operating system. Possible values correspond to the second
51-
parameter of files listed under the `configs/<DEVFAMILY>/` directory. For
52-
example `AM57X_linux_toc.txt` means that `linux` is a valid OS value.
53-
54-
Example build commands:
55-
56-
- Build linux documentation for AM335X
57-
58-
$ make DEVFAMILY=AM335X OS=linux
59-
60-
- Build android documentation for AM62X
39+
GNU Make handles some initial configuration. Specify the `DEVFAMILY` and `OS`
40+
values as either arguments to `make` or as environment variables before
41+
execution of `make`.
6142

62-
$ make DEVFAMILY=AM62X OS=android
43+
`DEVFAMILY` represents the Device Family. Possible values correspond to the
44+
names of directories listed under [`configs/`](configs/). For example:
6345

64-
- Build debian documentation for AM62PX
46+
- "AM335X" (representing AM335X family)
47+
- "AM437X" (representing AM437X family)
48+
- "AM57X" (representing AM57X family)
49+
- "AM64X" (representing AM64X family)
50+
- "AM62X" (representing AM62X family)
51+
- "AM62AX" (representing AM62AX family)
52+
- "AM62PX" (representing AM62PX family)
53+
- "AM62LX" (representing AM62L family)
54+
- "AM62DX" (representing AM62D family)
55+
- "AM65X" (representing AM65X family)
56+
- "DRA821A" (representing DRA821A)
57+
- "J721E" (representing Jacinto 7 ES)
58+
- "J7200" (representing Jacinto 7 VCL)
59+
- "J721S2" (representing Jacinto 7 AEP)
60+
- "J784S4" (representing Jacinto 7 AHP)
61+
- "J722S" (representing Jacinto 7 AEN)
6562

66-
$ make DEVFAMILY=AM62PX OS=debian
67-
68-
- Build EdgeAI documentation for AM62AX
69-
70-
$ make DEVFAMILY=AM62AX OS=edgeai
71-
72-
### HTML Page Output
63+
`OS` represents the operating system. Possible values correspond to the second
64+
parameter of files listed under the `configs/<DEVFAMILY>/` directory. For
65+
example `AM57X_linux_toc.txt` means that `linux` is a valid `OS` value.
7366

74-
Open the index page in a web browser
67+
Example build commands:
7568

76-
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
77-
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
78-
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
79-
edgeai: ./build/processor-sdk-edgeai-<FAMILY>/esd/docs/[version]/index.html
69+
- Build Linux documentation for AM335X
70+
```
71+
make DEVFAMILY=AM335X OS=linux
72+
```
73+
- Build Android documentation for AM62X
74+
```
75+
make DEVFAMILY=AM62X OS=android
76+
```
77+
- Build Debian documentation for AM62PX
78+
```
79+
make DEVFAMILY=AM62PX OS=debian
80+
```
81+
- Build EdgeAI documentation for AM62AX
82+
```
83+
make DEVFAMILY=AM62AX OS=edgeai
84+
```
85+
86+
### Document output
87+
88+
Currently only HTML output is possible. The output is available in directories
89+
matching the following structure on a successful build:
90+
91+
```
92+
./build/processor-sdk-<OS>-<DEVFAMILY>/esd/docs/<VERSION>/index.html
93+
```
8094
8195
## Contributing
8296
8397
See the [contribution guidelines](CONTRIBUTING.md) for information about
8498
formatting guidelines, workflows, and common issues.
8599
86-
## Live Preview on GitHub Pages
100+
## Development previews through GitHub Pages
87101
88-
GitHub Pages are now live for all `DEVFAMILY` and `OS` supported by this repository.
89-
This means that for every pull request merged into the master branch, an equivalent
90-
preview will be available on GitHub Pages immediately.
102+
GitHub Pages are now live for all `DEVFAMILY` and `OS` supported by this
103+
repository. This means that the current `master` branch build is available on
104+
GitHub Pages.
91105
92106
You can access the latest bleeding-edge documentation at the following link:
93-
- [Processor SDK Documentation](https://texasinstruments.github.io/processor-sdk-doc/)
107+
https://texasinstruments.github.io/processor-sdk-doc/
94108
95-
Please treat GitHub Pages as the most up-to-date source of documentation.
109+
Please treat the GitHub Pages deployment as the most up-to-date source of
110+
documentation.

0 commit comments

Comments
 (0)