aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormerakor <cem@ckyln.com>2021-02-28 13:29:18 +0000
committermerakor <cem@ckyln.com>2021-02-28 13:29:18 +0000
commitcb7a8dcdd8509a0f9d1d06e6f6485af5e791f921 (patch)
tree967858f45cff392a940f360291259e88d0a7148c
parent8459661793314095fdc6780b8981bad33a0e0e95 (diff)
downloadcpt-cb7a8dcdd8509a0f9d1d06e6f6485af5e791f921.tar.gz
README: update
FossilOrigin-Name: dc4c716ef4049d38cbe40f4da00892d0fe9b8063d31df3f633f99e2fde5669a2
-rw-r--r--README.md (renamed from README)26
1 files changed, 10 insertions, 16 deletions
diff --git a/README b/README.md
index 202c68e..b7db05a 100644
--- a/README
+++ b/README.md
@@ -1,9 +1,3 @@
- ____ ____ _____
- / ___| _ \_ _|
-| | | |_) || |
-| |___| __/ | |
- \____|_| |_|
-
Carbs Packaging Tools
--------------------------------------------------------------------------------
@@ -19,19 +13,19 @@ Dependencies
To build and use cpt, you need the following software:
-- rsync
-- curl
-- POSIX base utilities [coreutils, busybox, sbase, etc.]
-- pax or tar [GNU tar, busybox, toybox, libarchive, etc.]
-- Common compression utilities such as gzip, bzip2, xz, etc.
+- `rsync`
+- `curl`
+- POSIX base utilities [`coreutils`, `busybox`, `sbase`, etc.]
+- `pax` or `tar` [GNU tar, busybox, toybox, libarchive, etc.]
+- Common compression utilities such as `gzip`, `bzip2`, `xz`, etc.
In order to build the documentation, you will need the following software:
-- texinfo (for generating '.info' pages)
-- Emacs (for generating '.texi' and '.txt' pages)
+- `texinfo` (for generating `.info` pages)
+- `Emacs` (for generating `.texi` and `.txt` pages)
-However, distributed tarballs come with info pages, and '.texi' and '.txt' files
+However, distributed tarballs come with info pages, and `.texi` and `.txt` files
are committed directly into the repository, meaning that you don't need
`texinfo` if you are using a tarball, and you don't need Emacs as long as you
don't edit the documentation.
@@ -54,10 +48,10 @@ Defining Base
--------------------------------------------------------------------------------
Tools such as cpt-orphans and cpt-reset define the base from the file
-'/etc/cpt-base'. An example cpt-base file can be found from the root directory
+`/etc/cpt-base`. An example cpt-base file can be found from the root directory
of the repository, which is the default base for Carbs Linux. A user can modify
this file to fit their needs and redefine their base for the system. For
-example, a user can decide that they want 'sbase' instead of 'busybox' for their
+example, a user can decide that they want `sbase` instead of `busybox` for their
base, so if they reset their system, busybox will be removed instead of sbase.
This file is used to ship a predefined base, while leaving the base to a user's