This might be enough documentation for tonight

main
Michal 2 years ago
parent a08b80c064
commit 03ba34525a
No known key found for this signature in database
GPG Key ID: A6A1A4DCB22279B9

@ -115,4 +115,4 @@ For mode-specific config, avert your eyes to the following links!
- [Workspace Mode](WORKSPACE_MODE.md) - [Workspace Mode](WORKSPACE_MODE.md)
- [Repository Mode](REPOSITORY_MODE.md) - [Repository Mode](REPOSITORY_MODE.md)
Alternatively, you can look at more [Detailed Usage](USAGE.md) Alternatively, you can look at the [Usage](USAGE.md) guide!

@ -0,0 +1,38 @@
# Repository Mode
PacManage your repositories in style!
### Repository Config
As opposed to the rather barren Workspace mode, the Repository mode config is rather fleshed out,
and we have a few options to choose from.
Let's take an example config,
```toml
[mode.repository]
name = "example"
build_on_update = true
[mode.repository.signing]
enabled = true
key = "you@example.org"
on_gen = true
```
### Basic Repository Config
To start with, there are 2 main config keys to Repository mode:
- `name`: Defines what pacman calls your repository.
- `build_on_update`: In conjunction with `smart_pull`, defines whether to rebuild packages automatically when an update is detected.
### Signing
Malachite also supports, and encourages the signing of packages.
GPG Signing packages ensures that the user receives exactly what you packaged, without any chance of tampering.
Calling back to the example above, we can see 3 config keys:
- `enabled`: Defines whether to sign packages (heavily encouraged).
- `key`: Defines the GPG key ID to use for signing.
- `on_gen`: Defines whether to sign packages when they are built, or all at once on repository generation (this is also recommended).

@ -0,0 +1,15 @@
# Workspace Mode
You'll never have to work(space) another day in your life!
### Workspace Config
```toml
[mode.workspace]
```
Oh, this is awkward. It seems like there *is no* workspace-specific config yet. I'm open to suggestions though!
### For Now...
You can return to [Getting Started](GETTING_STARTED.md), or head directly into [Repository Mode](REPOSITORY_MODE.md) to see where Malachite really shines!
Loading…
Cancel
Save