diff options
| author | kaotisk <kaotisk@arching-kaos.com> | 2021-12-14 03:42:41 +0200 |
|---|---|---|
| committer | kaotisk <kaotisk@arching-kaos.com> | 2021-12-14 03:42:41 +0200 |
| commit | e93bc58da017610d6f92d68b40f908d09d529d53 (patch) | |
| tree | 4557adb5766fc23f5fbff9c8e47cc52101f6abe6 | |
| download | arching-kaos-tools-e93bc58da017610d6f92d68b40f908d09d529d53.tar.gz arching-kaos-tools-e93bc58da017610d6f92d68b40f908d09d529d53.tar.bz2 arching-kaos-tools-e93bc58da017610d6f92d68b40f908d09d529d53.zip | |
Readme addition
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa634a3 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +Arching Kaos Tools +================== + +Description +----------- + +This is an installable repo which provides various tools for running Arching Kaos and use it. + +Requirements +------------ +Some Linx machine which has installed bash v5.1.8 or compatible or zsh v5.8 or compatible. + +If this gets any updates like newer version of bash/zsh or the repo it self, it would be +nice to know which the new versions are. + +If bash or zsh get that much updated that they can't take it no more... If you can, fix it! + +Clone +----- + +git clone ... + +Install +------- + +cd arching-kaos-tools +sh install.sh + +Defaults +-------- + +Installs binaries and scripts on your $HOME folder. + +TODO +---- + +[ ] - Install on zsh (export ~/bin to $PATH in .zshrc file) +[ ] - Install on bash (the same but to .bashrc file +[ ] - Make a useful tool of this + +Examples +-------- + +You could use ZCHAIN with NEWS model. Or MIXTAPE model, or make your own. |