diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 19301fc4..0d426d4b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by raising a -matter forum in the discussion section. All complaints will be reviewed and +matter forum in the Issues section. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/README.md b/README.md index 93669f1c..b208fe8d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ supply chain threat at least in the 2021-2023 era. Some good business reasons why AutomataCI is made: -1. **Start off with a tested and solid foundation** - all the templates and +1. **Start off with a tested and solid foundation** - All the templates and CI jobs are tested and have default configured for immediate software development. 2. **Avoid being threatend by your CI provider** - CI it's a life-support system @@ -157,18 +157,50 @@ decided your tech, you may remove all the unused source directories ### Git Commit Initial Setup At this point, your repo is now ready. Feel free to git commit your -initialization: +initialization (assuming you're using `main` as primary branch): ``` $ git add . $ git commit -s ... WRITE YOUR COMMIT ... $ git push -u origin main:main +$ git switch --orphan gh-pages +$ git commit --allow-empty -m "Initial Commit" +$ git push origin gh-pages:gh-pages +$ git checkout main ``` +## Operating AutomataCI + +To operate AutomataCI, simply execute the `ci.cmd` help section: + +``` +$ ./ci.cmd help + +Please try any of the following: + To seek commands' help 🠚 $ ./ci.cmd help + To initialize environment 🠚 $ ./ci.cmd env + To setup the repo for work 🠚 $ ./ci.cmd setup + To start a development 🠚 $ ./ci.cmd start + To test the repo 🠚 $ ./ci.cmd test + To prepare the repo 🠚 $ ./ci.cmd prepare + To build the repo 🠚 $ ./ci.cmd build + To package the repo product 🠚 $ ./ci.cmd package + To release the repo product 🠚 $ ./ci.cmd release + To stop a development 🠚 $ ./ci.cmd stop + To clean the workspace 🠚 $ ./ci.cmd clean + To purge everything 🠚 $ ./ci.cmd purge +``` + +The CI jobs are arranged in a storyline manner from top to bottom. Feel free +to execute accordingly. + + + + ## To Contribute AutomataCI cannot be made successfully without contributions from (Holloway) diff --git a/automataCI/AutomataCI-Engineering-Specification.odt b/automataCI/AutomataCI-Engineering-Specification.odt index 66478712..bbddc41b 100644 Binary files a/automataCI/AutomataCI-Engineering-Specification.odt and b/automataCI/AutomataCI-Engineering-Specification.odt differ diff --git a/automataCI/AutomataCI-Engineering-Specification.pdf b/automataCI/AutomataCI-Engineering-Specification.pdf index 9ac825b0..b0c1c750 100644 Binary files a/automataCI/AutomataCI-Engineering-Specification.pdf and b/automataCI/AutomataCI-Engineering-Specification.pdf differ