From 2cb1719e2138856993fa05789a84beadd169d8dc Mon Sep 17 00:00:00 2001 From: UsernameSwift Date: Sun, 24 Jul 2022 20:37:56 -0400 Subject: [PATCH] Minor changes to grammar in docs --- docs/COMMON_FEATURES.md | 2 +- docs/GETTING_STARTED.md | 10 +++++----- docs/REPOSITORY_MODE.md | 4 ++-- docs/USAGE.md | 4 ++-- docs/WORKSPACE_MODE.md | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/COMMON_FEATURES.md b/docs/COMMON_FEATURES.md index 1cd9031..b939316 100644 --- a/docs/COMMON_FEATURES.md +++ b/docs/COMMON_FEATURES.md @@ -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. 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. diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 1cc8627..6bd3462 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -15,21 +15,21 @@ Malachite isn't: ### 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 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. -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 What mode are you using malachite in? -Currently malachite supports 2 modes: +Currently, malachite supports 2 modes: #### Repository Mode - Allows the user to configure and manage a remote (or local) pacman-based package repository @@ -44,4 +44,4 @@ Currently malachite supports 2 modes: These modes essentially dictate everything about how Malachite functions, so much so that I now need to split this page off before it gets too long! -For more info, get started with the [Common Features](COMMON_FEATURES.md) page! \ No newline at end of file +For more info, get started with the [Common Features](COMMON_FEATURES.md) page! diff --git a/docs/REPOSITORY_MODE.md b/docs/REPOSITORY_MODE.md index 3242a8a..60a580c 100644 --- a/docs/REPOSITORY_MODE.md +++ b/docs/REPOSITORY_MODE.md @@ -3,7 +3,7 @@ PacManage your repositories in style! ### 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. 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 -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. Calling back to the example above, we can see 3 config keys: diff --git a/docs/USAGE.md b/docs/USAGE.md index 4a714e8..975f82c 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -24,8 +24,8 @@ Work it harder, make it better! | 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. | -| `BuildInWorkspace` | `2` | Malachite was ran in Workspace mode, but a Repository-mode-specific operation was supplied | +| `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 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 | | `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 | diff --git a/docs/WORKSPACE_MODE.md b/docs/WORKSPACE_MODE.md index 3167365..14efb54 100644 --- a/docs/WORKSPACE_MODE.md +++ b/docs/WORKSPACE_MODE.md @@ -24,8 +24,8 @@ The key for the values is as follows: 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. --- -You can return to [Getting Started](GETTING_STARTED.md) page here! \ No newline at end of file +You can return to [Getting Started](GETTING_STARTED.md) page here!