Skip to content

Commit

Permalink
README: Update instructions for setup and deployment
Browse files Browse the repository at this point in the history
Adds a snippet with `git clone` for the dependent repos.
Updates deployment information.
  • Loading branch information
wpiet authored and sjanc committed Sep 26, 2024
1 parent c7d70b3 commit cc7a97f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ Install the requirements:

NOTE: These instructions assume that your workspace has all the mynewt repos cloned under the same parent directory.

git clone https://github.com/apache/mynewt-documentation
git clone https://github.com/apache/mynewt-core
git clone https://github.com/apache/mynewt-nimble
git clone https://github.com/apache/mynewt-newt
git clone https://github.com/apache/mynewt-newtmgr

### First follow the steps at mynewt-documentation

Most steps for releasing docs happen at the
Expand Down Expand Up @@ -78,8 +84,8 @@ NOTE: Skip these steps if you are just refreshing the current documentation or s
1. This will leave you on the `asf-site` branch.
1. Commit & push the changes.

The runtime-bot github user does a build every ~15 minutes and opens a Pull
Request against the asf-site branch if there are any changes. It is recommended
The _GitHub Actions_ workflow performs a build whenever the master branch updates.
It opens a Pull Request against the `asf-site` branch if there are any changes. It is recommended
that the runtime-bot PRs are used to deploy changes to the site instead of PRs
from individual contributors. The runtime-bot PRs give us repeatable builds
using known versions of the build tools.
Expand Down

0 comments on commit cc7a97f

Please sign in to comment.