aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorseth <getchoo@tuta.io>2023-07-26 14:45:30 -0400
committerseth <getchoo@tuta.io>2023-07-26 14:49:09 -0400
commitf7ffbcca6c5490e24ee74486cfc6698a38512561 (patch)
tree80abb3ed1cdb4c774748267b9ba559306004f157
parent342a0d0091fafece11f2b18e38c3786f112ac20b (diff)
downloadPrismLauncher-f7ffbcca6c5490e24ee74486cfc6698a38512561.tar.gz
PrismLauncher-f7ffbcca6c5490e24ee74486cfc6698a38512561.tar.bz2
PrismLauncher-f7ffbcca6c5490e24ee74486cfc6698a38512561.zip
chore(docs): correct markdownlint warnings
Signed-off-by: seth <getchoo@tuta.io>
-rw-r--r--CONTRIBUTING.md5
-rw-r--r--libraries/README.md2
-rw-r--r--nix/NIX.md10
3 files changed, 11 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b2795ce4..07291677 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ In an effort to ensure that the code you contribute is actually compatible with
This can be done by appending `-s` to your `git commit` call, or by manually appending the following text to your commit message:
-```
+```text
<commit message>
Signed-off-by: Author name <Author email>
@@ -27,7 +27,7 @@ Signed-off-by: Author name <Author email>
By signing off your work, you agree to the terms below:
-```
+```text
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
@@ -62,7 +62,6 @@ As a bonus, you can also [cryptographically sign your commits][gh-signing-commit
[gh-signing-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
[gh-vigilant-mode]: https://docs.github.com/en/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits
-
## Backporting to Release Branches
We use [automated backports](https://github.com/PrismLauncher/PrismLauncher/blob/develop/.github/workflows/backport.yml) to merge specific contributions from develop into `release` branches.
diff --git a/libraries/README.md b/libraries/README.md
index 4da11314..e75a381e 100644
--- a/libraries/README.md
+++ b/libraries/README.md
@@ -61,7 +61,7 @@ The `standard` and `legacy` launchers are available.
Example (some parts have been censored):
-```
+```text
mod legacyjavafixer-1.0
mainClass net.minecraft.launchwrapper.Launch
param --username
diff --git a/nix/NIX.md b/nix/NIX.md
index 980d20e8..aa945acc 100644
--- a/nix/NIX.md
+++ b/nix/NIX.md
@@ -53,7 +53,8 @@ home.packages = [ pkgs.prismlauncher ];
### Without flakes-enabled nix
-#### Using channels
+<details>
+<summary>Using channels</summary>
```sh
nix-channel --add https://github.com/PrismLauncher/PrismLauncher/archive/master.tar.gz prismlauncher
@@ -61,7 +62,10 @@ nix-channel --update prismlauncher
nix-env -iA prismlauncher
```
-#### Using the overlay
+</details>
+
+<details>
+<summary>Using the overlay</summary>
```nix
# In your configuration.nix:
@@ -74,6 +78,8 @@ nix-env -iA prismlauncher
}
```
+</details>
+
## Running ad-hoc
If you're on a flakes-enabled nix you can run the launcher in one-line