Skip to content

Commit c59d92e

Browse files
root: updated documentations for releases
Since the repository is now ready, we should update it for release. Hence, let's do this. This patch updates documentations for releases in root repository. Co-authored-by: Galyna, Cory <124406765+corygalyna@users.noreply.github.com> Co-authored-by: (Holloway) Chew, Kean Ho <hollowaykeanho@gmail.com> Signed-off-by: (Holloway) Chew, Kean Ho <hollowaykeanho@gmail.com>
1 parent c7340fa commit c59d92e

File tree

4 files changed

+35
-3
lines changed

4 files changed

+35
-3
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement by raising a
63-
matter forum in the discussion section. All complaints will be reviewed and
63+
matter forum in the Issues section. All complaints will be reviewed and
6464
investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ supply chain threat at least in the 2021-2023 era.
1313

1414
Some good business reasons why AutomataCI is made:
1515

16-
1. **Start off with a tested and solid foundation** - all the templates and
16+
1. **Start off with a tested and solid foundation** - All the templates and
1717
CI jobs are tested and have default configured for immediate software
1818
development.
1919
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
157157
### Git Commit Initial Setup
158158

159159
At this point, your repo is now ready. Feel free to git commit your
160-
initialization:
160+
initialization (assuming you're using `main` as primary branch):
161161

162162
```
163163
$ git add .
164164
$ git commit -s
165165
... WRITE YOUR COMMIT ...
166166
$ git push -u origin main:main
167+
$ git switch --orphan gh-pages
168+
$ git commit --allow-empty -m "Initial Commit"
169+
$ git push origin gh-pages:gh-pages
170+
$ git checkout main
167171
```
168172

169173

170174

171175

176+
## Operating AutomataCI
177+
178+
To operate AutomataCI, simply execute the `ci.cmd` help section:
179+
180+
```
181+
$ ./ci.cmd help
182+
183+
Please try any of the following:
184+
To seek commands' help 🠚 $ ./ci.cmd help
185+
To initialize environment 🠚 $ ./ci.cmd env
186+
To setup the repo for work 🠚 $ ./ci.cmd setup
187+
To start a development 🠚 $ ./ci.cmd start
188+
To test the repo 🠚 $ ./ci.cmd test
189+
To prepare the repo 🠚 $ ./ci.cmd prepare
190+
To build the repo 🠚 $ ./ci.cmd build
191+
To package the repo product 🠚 $ ./ci.cmd package
192+
To release the repo product 🠚 $ ./ci.cmd release
193+
To stop a development 🠚 $ ./ci.cmd stop
194+
To clean the workspace 🠚 $ ./ci.cmd clean
195+
To purge everything 🠚 $ ./ci.cmd purge
196+
```
197+
198+
The CI jobs are arranged in a storyline manner from top to bottom. Feel free
199+
to execute accordingly.
200+
201+
202+
203+
172204
## To Contribute
173205

174206
AutomataCI cannot be made successfully without contributions from (Holloway)
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)