Skip to content

Commit 4c4e68f

Browse files
authored
Update README.md
Clarity
1 parent 4028f23 commit 4c4e68f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ This repository uses a custom GitHub Actions workflow [`build-and-deploy-javadoc
99

1010
### How It Works
1111

12-
- **Scheduled Run:** The workflow is triggered every Monday at midnight (UTC) to ensure that the Javadocs are always up-to-date.
13-
- **Manual Trigger:** You can also manually trigger the workflow if needed.
14-
- **Javadocs Generation:** The workflow clones the `processing/processing4` repository, builds the Javadocs using `ant`, and copies the generated files to the `/docs` directory of this repository.
15-
- **Update Source Files:** The updated Javadocs are committed and pushed to the `gh-pages` branch.
16-
- **Deployment:** We've set "Deploy from branch" in the repo settings to trigger on push to the `gh-pages` branch.
12+
The workflow clones the `processing/processing4` repository, builds the Javadocs using `ant`, and copies the generated files to the `/docs` directory of this repository. The updated Javadocs are then committed and pushed to the `gh-pages` branch.
13+
14+
The workflow is triggered every Monday at midnight (UTC) to ensure that the Javadocs are always up-to-date. You can also manually trigger the workflow if needed.
15+
16+
We've set "Deploy from branch" in the repo settings to trigger on push to the `gh-pages` branch. Every time the `build-and-deploy-javadoc.yml` workflow completes, it will trigger a deploy to GitHub pages.
1717

1818
This automation helps keep the Javadocs updated without requiring manual intervention.
1919

0 commit comments

Comments
 (0)