parchlinux-mobile/kupferbootstrap
1
0
Fork 1
mirror of https://gitlab.com/kupfer/kupferbootstrap.git synced 2025-02-22 21:25:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: convert absolute links to relative

Browse source
This commit is contained in:
InsanePrawn 2023-12-19 23:34:33 +01:00
parent ff8a529690
commit 95147cecea
3 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/source/usage/config.md
View file

@ -2,10 +2,14 @@
Kupferbootstrap uses [toml](https://en.wikipedia.org/wiki/TOML) for its configuration file. Kupferbootstrap uses [toml](https://en.wikipedia.org/wiki/TOML) for its configuration file.
The file can either be edited manually or managed via the {doc}`../cli/config` subcommand. The file can either be edited manually or managed via the [`kupferbootstrap config`](../../cli/config) subcommand.
```{hint}
You can quickly generate a default config by running {code}`kupferbootstrap config init -N`. You can quickly generate a default config by running {code}`kupferbootstrap config init -N`.
For an interactive dialogue, omit the `-N`.
```
## File Location ## File Location
The configuration is stored in `~/.config/kupfer/kupferbootstrap.toml`, where `~` is your user's home folder. The configuration is stored in `~/.config/kupfer/kupferbootstrap.toml`, where `~` is your user's home folder.
@ -54,7 +58,7 @@ This allows you to easily keep a number of slight variations of the same target
without the need to constantly modify your Kupferbootstrap configuration file. without the need to constantly modify your Kupferbootstrap configuration file.
You can easily create new profiles with You can easily create new profiles with
[kupferbootstrap config profile init](/cli/config/#kupferbootstrap-config-profile-init). [kupferbootstrap config profile init](../../cli/config/#kupferbootstrap-config-profile-init).
Here's an example: Here's an example:
@ -97,7 +101,7 @@ hostname = "pocof1"
The `current` key in the `profiles` section controlls which profile gets used by Kupferbootstrap by default. The `current` key in the `profiles` section controlls which profile gets used by Kupferbootstrap by default.
The first subsection (`profiles.default`) describes the `default` profile The first subsection (`profiles.default`) describes the `default` profile
which gets created by [config init](/cli/config/#kupferbootstrap-config-init). which gets created by [`kupferbootstrap config init`](../../cli/config/#kupferbootstrap-config-init).
Next, we have a `graphical` profile that defines a couple of graphical programs for all but the `recovery` profile, Next, we have a `graphical` profile that defines a couple of graphical programs for all but the `recovery` profile,
since that doesn't have a GUI. since that doesn't have a GUI.

2
docs/source/usage/faq.md
View file

@ -19,7 +19,7 @@ See [Porting](../porting)
## How to build a specific package ## How to build a specific package
See also: The full [`kupferbootstrap packages build` docs](/cli/packages#kupferbootstrap-packages-build) See also: The full [`kupferbootstrap packages build` docs](../../cli/packages#kupferbootstrap-packages-build)
### Example ### Example

6
docs/source/usage/quickstart.md
View file

@ -2,8 +2,8 @@
1. [Install](../install) Kupferbootstrap 1. [Install](../install) Kupferbootstrap
1. [Configure](../config) it: `kuperbootstrap config init` 1. [Configure](../config) it: `kuperbootstrap config init`
1. [Update your PKGBUILDs + SRCINFO cache](/cli/packages#kupferbootstrap-packages-update): `kupferbootstrap packages update` 1. [Update your PKGBUILDs + SRCINFO cache](../../cli/packages#kupferbootstrap-packages-update): `kupferbootstrap packages update`
1. [Build an image](/cli/image#kupferbootstrap-image-build): `kupferbootstrap image build` 1. [Build an image](../../cli/image#kupferbootstrap-image-build): `kupferbootstrap image build`
1. [Flash the image](/cli/image#kupferbootstrap-image-flash): `kupferbootstrap image flash abootimg && kupferbootstrap image flash full userdata` 1. [Flash the image](../../cli/image#kupferbootstrap-image-flash): `kupferbootstrap image flash abootimg && kupferbootstrap image flash full userdata`
See also: [Frequently Asked Questions](../faq) See also: [Frequently Asked Questions](../faq)