aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.org>2024-06-10 18:23:08 +0300
committerkaotisk <kaotisk@arching-kaos.org>2024-06-10 18:23:08 +0300
commit6b93bf4d3a8dfd572f14ba7bc5c7bb01e5e70754 (patch)
tree4db686d2f60474e630795de5eb5a8f93129d6af5 /README
parentc581cd642440a5ac077f5073f6fbe3920b729ba7 (diff)
downloadarching-kaos-tools-6b93bf4d3a8dfd572f14ba7bc5c7bb01e5e70754.tar.gz
arching-kaos-tools-6b93bf4d3a8dfd572f14ba7bc5c7bb01e5e70754.tar.bz2
arching-kaos-tools-6b93bf4d3a8dfd572f14ba7bc5c7bb01e5e70754.zip
README update
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 11 insertions, 10 deletions
diff --git a/README b/README
index 8f34d7d..17fb900 100644
--- a/README
+++ b/README
@@ -36,9 +36,10 @@ This is an installable repository which provides various tools for running
Arching Kaos and using it.
Generic tools:
-`ak enter` - Can be used to crawl zchains.
-`ak zchain --rebase` - Can be used to rebase your zchain to a previous zblock.
-`ak zchain --reset` - Can be used to reset your zchain to zgenesis.
+- `ak` - The tools wrapper
+- `ak enter` - Can be used to crawl zchains.
+- `ak zchain --rebase` - Can be used to rebase your zchain to a previous zblock.
+- `ak zchain --reset` - Can be used to reset your zchain to zgenesis.
Modules:
You can use previously known modules or make new ones and put them into your
@@ -48,8 +49,8 @@ modules/
└─ <module name>
└─ main.sh
```
-`ak-mixtapes` and `news` - Can be used to add content to your zchain.
-`ak-profile` - Can be used to build up a profile of the contributor.
+- `mixtapes` and `news` - Can be used to add content to your zchain.
+- `profile` - Can be used to build up a profile of the contributor.
Based on your GPG, zchain and other values provided by `profile`, you can create
with `akconfig` a pointer to some basic information that you can share with
@@ -189,11 +190,11 @@ podman build -f ContainerFile -t arching-kaos-tools .
Specialized ContainerFiles are available in `./podman/` for various
distributions:
- - alpine
- - archlinux
- - debian
- - fedora
- - opensuse
+- alpine
+- archlinux
+- debian
+- fedora
+- opensuse
More over there are two scripts for testing with podman:
1. `./test_with_podman.sh` - build one or all images