Skip to content

docs(README): Add a section for Github Pages #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StaticRocket merged 1 commit into from
Dec 16, 2024
Merged

docs(README): Add a section for Github Pages #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ Open the index page in a web browser
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html

## Live Preview on GitHub Pages

GitHub Pages are now live for all `DEVFAMILY` and `OS` supported by this repository.
This means that for every pull request merged into the master branch, an equivalent
preview will be available on GitHub Pages immediately.

You can access the latest bleeding-edge documentation at the following link:
- [Processor SDK Documentation](https://texasinstruments.github.io/processor-sdk-doc/)

Please treat GitHub Pages as the most up-to-date source of documentation.

## Tips and Tricks

Add the following to your `init.vim` to automatically use the standard
Expand Down
Loading