aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 20 insertions, 21 deletions
diff --git a/README b/README
index 72c800e..a3b3e51 100644
--- a/README
+++ b/README
@@ -1,44 +1,43 @@
carbs rootfs script
-------------------
-Tool for generating rootfs tarballs for Carbs Linux. But
-it can be configured to create tarballs for KISS, create
-a personalized pre-configured tarball with an Xorg server
-to ease installation process. Tarballs on
-https://dl.carbslinux.org are generated from this script.
+Tool for generating rootfs tarballs for Carbs Linux. But it can be configured to
+create tarballs for KISS, create a personalized pre-configured tarball with an
+Xorg server to ease installation process. Tarballs on https://dl.carbslinux.org
+are generated from this script.
configuration
-------------
-Configuration can be done by copying config.def file to
-config. There you can configure where the rootfs will be
-created, packages to be installed, CFLAGS, MAKEFLAGS,
-repository to be added, and the `KISS_PATH` to be used.
+Configuration can be done by copying config.def file to config. There you can
+configure where the rootfs will be created, packages to be installed, CFLAGS,
+MAKEFLAGS, repository to be added, and the `KISS_PATH` to be used.
extra repositories
------------------
-The script by default only installs a single repository,
-but can accept a file named 'repositories' to add additional
-repositories to the target system. This file is structured
-in a plaintext manner and has 3 seperate sections.
+The script by default only installs a single repository, but can accept a file
+named 'repositories' to add additional repositories to the target system. This
+file is structured in a plaintext manner and has 3 seperate sections.
1. Git URL
2. Target location
3. Git clone options (such as --depth 1)
-Here is an example repositories file. The local repository is
-for example purposes, don't actually use local repositories.
+Here is an example repositories file. The local repository is for example
+purposes, don't actually use local repositories.
- https://git.u.com/repo1 /var/db/kiss/personalrepo --depth 1
- /home/user/kiss-repo2 /var/db/kiss/kiss-repo2 --no-local --depth 2
+ +--------------------------------------------------------------------------+
+ | https://git.u.com/repo1 /var/db/kiss/personalrepo --depth 1 |
+ | /home/user/kiss-repo2 /var/db/kiss/kiss-repo2 --no-local --depth 2 |
+ +--------------------------------------------------------------------------+
-You can then add these to your KISS_PATH by editing the
-config file and adding the following to your `HOST_REPO_PATH`.
+You can then add these to your KISS_PATH by editing the config file and adding
+the following to your `HOST_REPO_PATH`.
HOST_REPO_PATH="/tmp/repo/core:$MNTDIR/var/db/kiss/personalrepo:$MNTDIR/var/db/kiss/kiss-repo2"
@@ -47,5 +46,5 @@ config file and adding the following to your `HOST_REPO_PATH`.
postinstall
-----------
-You can change the postinstall (which defaults to true) function to
-make manual changes to the generated root filesystem. \ No newline at end of file
+You can change the postinstall (which defaults to true) function to make manual
+changes to the generated root filesystem. \ No newline at end of file