Skip to content

Commit

Permalink
README.md: finalized for next release
Browse files Browse the repository at this point in the history
Since the next release is ready, I best finalize the README.md again.
Hence, let's do this.

This patch finalizes README.md for the next release.

Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
hollowaykeanho committed Apr 1, 2024
1 parent 4a8caba commit 0d9ff2a
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Turn every computer's terminal into an interactive AI prompt.
[![hollowayHIAI-demo-debian](src/screenshots/hiAI-demo-debian.gif)](#holloways-hiai)


> [!important]
>
> Special thanks to [Google](https://gemini.google.com/) for sponsoring its
> [Google Gemini Advanced Ultra](https://ai.google.dev/pricing) services allowing
> this app to be possibly realized.



## Why It Matters
Expand Down Expand Up @@ -43,7 +50,7 @@ The software is packaged based on available OSes.
1. Download the latest `.deb` package from the [release section](https://github.com/ChewKeanHo/APP_hiAI/releases)
2. perform `$ dpkg -i <package>.deb`.

Don't worry, the package will setup the upstream apt repository list source
Don't worry, the package will setup the upstream `apt` repository list source
alongside the required GPG key for future `apt update`.


Expand All @@ -53,7 +60,7 @@ alongside the required GPG key for future `apt update`.
1. Download the latest `.rpm` package from the [release section](https://github.com/ChewKeanHo/APP_hiAI/releases)
2. perform `$ rpm -i <package>.rpm`.

Don't worry, the package will setup the upstream apt repository list source
Don't worry, the package will setup the upstream `yum` repository list source
alongside the required GPG key for future `apt update`.


Expand Down Expand Up @@ -87,7 +94,7 @@ For direct installation in FlatHub, it's still work in progress.

### Docker / Podman

The Docker version is hosted on
The container distribution is hosted on
[GitHub Packages](https://github.com/ChewKeanHo/APP_hiAI/pkgs/container/hollowayhiai).
Please keep in mind that the packages section is continuously updated with
development so the catalog can be confusing (e.g. you may see some development
Expand All @@ -102,19 +109,20 @@ $ docker pull ghcr.io/chewkeanho/hollowayhiai:latest
# $ docker pull ghcr.io/chewkeanho/hollowayhiai:[VERSION_WITHOUT_V_PREFIX]
# Example for `v0.0.2`:
# $ docker pull ghcr.io/chewkeanho/hollowayhiai:0.0.2
$ docker pull ghcr.io/chewkeanho/hollowayhiai:0.0.2
```

To run with Docker, you need to mount your config file and execute using the
`ARGS` environment variables. The `--config` argument **MUST** match with
the pathing you mounted to. For example:
the pathing you mounted to (`target=`). For example:

```
# note - '-it' must always be the last argument
$ docker run --env ARGS="--config /CONFIG.toml --text2text 'Who are you?'" \
--mount type=bind,source="${HOME}/CONFIG.toml",target="/CONFIG.toml" \
--mount type=bind,source="/path/to/CONFIG.toml",target="/CONFIG.toml" \
-it ghcr.io/chewkeanho/hollowayhiai:[VERSION_WITHOUT_V_PREFIX]
# to call for help
$ docker run --env ARGS="--help" ghcr.io/chewkeanho/hollowayhiai:[VERSION_WITHOUT_V_PREFIX]
```
Expand All @@ -125,8 +133,9 @@ $ docker run --env ARGS="--help" ghcr.io/chewkeanho/hollowayhiai:[VERSION_WITHOU

Use the `tar.gz` package or `zip` package on Windows OS.

Note that the command to use is: `hollowayhiai_[OS]-[ARCH].sh.ps1` instead of
the `hollowayHIAI` sine you're executing directly from the script.
Note that the command to use is: `hollowayhiai_[OS]-[ARCH].sh.ps1` (with file
extensions) instead of the guided `hollowayHIAI` since you're executing directly
from the script.



Expand Down Expand Up @@ -161,7 +170,7 @@ $ powershell.exe -noprofile `
-Command "& .\hollowayhiai_windows-[ARCH].sh.ps1 --config path\to\file.toml --text2text `"...your prompt...`""
```

In any cases, if you need an on-screen assistances:
In any cases, if you need any on-screen assistances:
```
# UNIX (Linux & MacOS) - POSIX Shell
$ hollowayHIAI --help
Expand Down Expand Up @@ -202,16 +211,6 @@ free to refer the PDF Handbook and execute accordingly.



### Special Thanks

Special thanks to:

1. [Google](https://gemini.google.com/) for sponsoring its
[Google Gemini Advanced Ultra](https://ai.google.dev/pricing) services
for making this app possible.




## License
Holloway's HiAI! is licensed under OSI compatible
Expand Down

0 comments on commit 0d9ff2a

Please sign in to comment.