Skip to content

Commit

Permalink
README.md: updated with how-tos guides
Browse files Browse the repository at this point in the history
In case of quick references, it's best to add in the how-to guides
for now. Hence, let's do this.

This patch updates README.md with how-tos guides.

Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
hollowaykeanho committed Mar 29, 2024
1 parent 158e999 commit 9dec1a6
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,43 @@ Some good business reasons why using AutomataCI:


## How-tos, Documentations & Specifications
TBD

To use HiAI, you need to first setup 1-time `CONFIG.toml` file:

```
# in POSIX Shell
$ ./hiAI.sh.ps1 --create-config path/to/file.toml
# in Powershell
$ powershell.exe -noprofile -executionpolicy bypass `
-Command "& .\hiAI.sh.ps1 --create-config 'path\to\file.toml'"
# update the path/to/file.toml especially with the API token.
```

Once done, you may proceed to execute it:

```
# POSIX Shell
$ hiAI.sh.ps1 --config path/to/file.toml --text2text "...your prompt..."
# PowerShell
$ powershell.exe -noprofile -executionpolicy bypass `
-Command "& .\hiAI.sh.ps1 --config path\to\file.toml --text2text `"...your prompt...`""
```

In any cases, if you need an on-screen assistances:
```
# POSIX Shell
$ hiAI.sh.ps1 --help
# PowerShell
$ powershell.exe -noprofile -executionpolicy bypass `
-Command "& .\hiAI.sh.ps1 --help"
```



Expand Down

0 comments on commit 9dec1a6

Please sign in to comment.