Merge pull request #10 from UsernameSwift/development

Minor changes to grammar in docs
main
Michal 2 years ago committed by GitHub
commit e581c60d39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -5,7 +5,7 @@ As[mode]us, shared of between uh… repositories… or something.
Malachite is fairly fleshed out in Repository mode, and not so much in Workspace mode. Malachite is fairly fleshed out in Repository mode, and not so much in Workspace mode.
This isn't of course because I'm lazy and hate Workspace mode or anything, there's just not This isn't of course because I'm lazy and hate Workspace mode or anything, there's just not
a lot *to* add. a lot *to add*.
Without further ado, let's take a look at this example config file. Without further ado, let's take a look at this example config file.

@ -15,21 +15,21 @@ Malachite isn't:
### With that out of the way ### With that out of the way
Hi! My name is Michal, I wrote this tool pretty much on my own for [Crystal Linux](https://getcryst.al), Hi! My name is Michal, and I wrote this tool pretty much on my own for [Crystal Linux](https://getcryst.al);
but it is not at all exclusive to Crystal. This tool should and will work on and for any pacman-based but it is not at all exclusive to Crystal. This tool should and will work on and for any pacman-based
distribution (so long as it packages all of Malachite's dependencies, of course). distribution (so long as it packages all of Malachite's dependencies, of course).
Throughout this tutorial I'll explain each little feature of Malachite in what I hope to be bite-sized and Throughout this tutorial, I'll explain each little feature of Malachite in what I hope to be bite-sized and
programmatic chunks. programmatic chunks.
Without further ado, let's begin with the first most important question Without further ado, let's begin with the first, most important question:
### Modes ### Modes
What mode are you using malachite in? What mode are you using malachite in?
Currently malachite supports 2 modes: Currently, malachite supports 2 modes:
#### Repository Mode #### Repository Mode
- Allows the user to configure and manage a remote (or local) pacman-based package repository - Allows the user to configure and manage a remote (or local) pacman-based package repository

@ -3,7 +3,7 @@ PacManage your repositories in style!
### Repository Config ### Repository Config
As opposed to the rather barren Workspace mode, the Repository mode config is rather fleshed out, 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. and we have a few options to choose from.
Let's take an example section from a Repository mode config, Let's take an example section from a Repository mode config,
@ -27,7 +27,7 @@ To start with, there are 2 main config keys to Repository mode:
### Signing ### Signing
Malachite also supports, and encourages the signing of packages. 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. 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: Calling back to the example above, we can see 3 config keys:

@ -24,8 +24,8 @@ Work it harder, make it better!
| AppExitCode (named Enum) | Exit code (i32) | Error Description | | AppExitCode (named Enum) | Exit code (i32) | Error Description |
|--------------------------|-----------------|--------------------------------------------------------------------------------------------------------| |--------------------------|-----------------|--------------------------------------------------------------------------------------------------------|
| `RunAsRoot` | `1` | Malachite was ran as root. This is highly discouraged. So highly, in fact, that it will refuse to run. | | `RunAsRoot` | `1` | Malachite was run as root. This is highly discouraged. So highly, in fact, that it will refuse to run. |
| `BuildInWorkspace` | `2` | Malachite was ran in Workspace mode, but a Repository-mode-specific operation was supplied | | `BuildInWorkspace` | `2` | Malachite was run in Workspace mode, but a Repository-mode-specific operation was supplied |
| `PkgNotFound` | `3` | A build was attempted for a package that does not exist | | `PkgNotFound` | `3` | A build was attempted for a package that does not exist |
| `InvalidMode` | `4` | Malachite was launched in a mode other than `workspace` or `repository` | | `InvalidMode` | `4` | Malachite was launched in a mode other than `workspace` or `repository` |
| `DirNotEmpty` | `5` | The creation of a Malachite repository was attempted in a non-empty directory | | `DirNotEmpty` | `5` | The creation of a Malachite repository was attempted in a non-empty directory |

@ -24,7 +24,7 @@ The key for the values is as follows:
These will be typically displayed in either Green (Clean) or Red (Dirty) These will be typically displayed in either Green (Clean) or Red (Dirty)
However, if `colorblind` is set to true, the colors will instead be set to Blue (Clean) or Dark Red (Dirty), to be more discernible to colorblind users However, if `colorblind` is set to true, the colors will instead be set to Blue (Clean) or Dark Red (Dirty), to be more discernible to colorblind users.
--- ---

Loading…
Cancel
Save