From 8cea57ff0f06e1cc7ec58716e8177e3a0b6e5ee9 Mon Sep 17 00:00:00 2001 From: txtsd Date: Sat, 6 Aug 2022 12:53:50 +0530 Subject: chore(markdown): MD022 Headings should be surrounded by blank lines Signed-off-by: txtsd --- libraries/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'libraries/README.md') diff --git a/libraries/README.md b/libraries/README.md index f225ade8..2feaea9e 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -3,6 +3,7 @@ This folder has third-party or otherwise external libraries needed for other parts to work. ## classparser + A simplistic parser for Java class files. This library has served as a base for some (much more full-featured and advanced) work under NDA for AVG. It, however, should NOT be confused with that work. @@ -18,16 +19,19 @@ See [github repo](https://github.com/FeralInteractive/gamemode). BSD licensed ## hoedown + Hoedown is a revived fork of Sundown, the Markdown parser based on the original code of the Upskirt library by Natacha Porté. See [github repo](https://github.com/hoedown/hoedown). ## javacheck + Simple Java tool that prints the JVM details - version and platform bitness. Do what you want with it. It is so trivial that noone cares. ## Katabasis + Oauth2 library customized for Microsoft authentication. This is a fork of the [O2 library](https://github.com/pipacs/o2). @@ -35,6 +39,7 @@ This is a fork of the [O2 library](https://github.com/pipacs/o2). MIT licensed. ## launcher + Java launcher part for Minecraft. It: @@ -131,6 +136,7 @@ launcher onesix Available under `GPL-3.0-only` (with classpath exception), sublicensed from its original `Apache-2.0` codebase ## libnbtplusplus + libnbt++ is a free C++ library for Minecraft's file format Named Binary Tag (NBT). It can read and write compressed and uncompressed NBT files and provides a code interface for working with NBT data. See [github repo](https://github.com/ljfa-ag/libnbtplusplus). @@ -138,6 +144,7 @@ See [github repo](https://github.com/ljfa-ag/libnbtplusplus). Available either under LGPL version 3 or later. ## LocalPeer + Library for making only one instance of the application run at all times. BSD licensed, derived from [QtSingleApplication](https://github.com/qtproject/qt-solutions/tree/master/qtsingleapplication). @@ -157,6 +164,7 @@ A zip manipulation library, forked for MultiMC's use. LGPL 2.1 ## rainbow + Color functions extracted from [KGuiAddons](https://inqlude.org/libraries/kguiaddons.html). Used for adaptive text coloring. Available either under LGPL version 2.1 or later. -- cgit From 358f080c76dbdfc65f32e08448a5e38b78d2bab0 Mon Sep 17 00:00:00 2001 From: txtsd Date: Tue, 12 Jul 2022 20:46:06 +0530 Subject: chore(markdown): MD012 Multiple consecutive blank lines Signed-off-by: txtsd --- CODE_OF_CONDUCT.md | 1 - CONTRIBUTING.md | 2 -- README.md | 1 - libraries/README.md | 1 - libraries/katabasis/acknowledgements.md | 2 -- libraries/tomlc99/README.md | 2 -- 6 files changed, 9 deletions(-) (limited to 'libraries/README.md') diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 18031f9e..7bbd01da 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -134,4 +134,3 @@ For answers to common questions about this code of conduct, see the FAQ at [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 216549c6..7b60daf4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,5 @@ These terms will be enforced once you create a pull request, and you will be inf As a bonus, you can also [cryptographically sign your commits][gh-signing-commits] and enable [vigilant mode][gh-vigilant-mode] on GitHub. - - [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 diff --git a/README.md b/README.md index 167e7fc1..210bdb00 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ If you want to read about why this fork was created, check out [our FAQ page](ht - All downloads and instructions for PolyMC can be found [here](https://polymc.org/download/) - Last build status: https://github.com/PolyMC/PolyMC/actions - ## Development Builds There are per-commit development builds available [here](https://github.com/PolyMC/PolyMC/actions). These have debug information in the binaries, so their file sizes are relatively larger. diff --git a/libraries/README.md b/libraries/README.md index 2feaea9e..90e836e1 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -188,4 +188,3 @@ Licenced under the MIT licence. Tiny implementation of LZMA2 de/compression. This format is only used by Forge to save bandwidth. Public domain. - diff --git a/libraries/katabasis/acknowledgements.md b/libraries/katabasis/acknowledgements.md index c1c8a3d4..21e73e5d 100644 --- a/libraries/katabasis/acknowledgements.md +++ b/libraries/katabasis/acknowledgements.md @@ -26,7 +26,6 @@ > OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - # SimpleCrypt by Andre Somers Cryptographic methods for Qt. @@ -107,4 +106,3 @@ Bug fixes, support for ```qml``` module # Fabian Vogt Bug fixes, support for building without Qt keywords enabled - diff --git a/libraries/tomlc99/README.md b/libraries/tomlc99/README.md index 6715b5be..d2776448 100644 --- a/libraries/tomlc99/README.md +++ b/libraries/tomlc99/README.md @@ -10,7 +10,6 @@ If you are looking for a C++ library, you might try this wrapper: [https://githu [iarna/toml-spec-tests](https://github.com/iarna/toml-spec-tests). * Provides very simple and intuitive interface. - ## Usage Please see the `toml.h` file for details. What follows is a simple example that @@ -183,7 +182,6 @@ To test against the standard test set provided by BurntSushi/toml-test: % bash run.sh # this will run the test suite ``` - To test against the standard test set provided by iarna/toml: ```sh -- cgit From 8085b2728d573693f05874de550171e50dbd111a Mon Sep 17 00:00:00 2001 From: txtsd Date: Wed, 13 Jul 2022 00:14:11 +0530 Subject: chore(markdown): MD032 Lists should be surrounded by blank lines Signed-off-by: txtsd --- CONTRIBUTING.md | 1 + README.md | 2 ++ libraries/README.md | 1 + program_info/README.md | 1 + 4 files changed, 5 insertions(+) (limited to 'libraries/README.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5156fa0..4bca126f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ Try to follow the existing formatting. If there is no existing formatting, you may use `clang-format` with our included `.clang-format` configuration. In general, in order of importance: + - Make sure your IDE is not messing up line endings or whitespace and avoid using linters. - Prefer readability over dogma. - Keep to the existing formatting. diff --git a/README.md b/README.md index f4829723..9c07666f 100644 --- a/README.md +++ b/README.md @@ -68,12 +68,14 @@ To modify download information or change packaging information send a pull reque ## Forking/Redistributing/Custom builds policy We don't care what you do with your fork/custom build as long as you follow the terms of the [license](LICENSE) (this is a legal responsibility), and if you made code changes rather than just packaging a custom build, please do the following as a basic courtesy: + - Make it clear that your fork is not PolyMC and is not endorsed by or affiliated with the PolyMC project (). - Go through [CMakeLists.txt](CMakeLists.txt) and change PolyMC's API keys to your own or set them to empty strings (`""`) to disable them (this way the program will still compile but the functionality requiring those keys will be disabled). If you have any questions or want any clarification on the above conditions please make an issue and ask us. Be aware that if you build this software without removing the provided API keys in [CMakeLists.txt](CMakeLists.txt) you are accepting the following terms and conditions: + - [Microsoft Identity Platform Terms of Use](https://docs.microsoft.com/en-us/legal/microsoft-identity-platform/terms-of-use) - [CurseForge 3rd Party API Terms and Conditions](https://support.curseforge.com/en/support/solutions/articles/9000207405-curse-forge-3rd-party-api-terms-and-conditions) diff --git a/libraries/README.md b/libraries/README.md index 90e836e1..990d0597 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -43,6 +43,7 @@ MIT licensed. Java launcher part for Minecraft. It: + * Starts a process * Waits for a launch script on stdin * Consumes the launch script you feed it diff --git a/program_info/README.md b/program_info/README.md index 1e805d4a..421ef1f9 100644 --- a/program_info/README.md +++ b/program_info/README.md @@ -1,6 +1,7 @@ # PolyMC Program Info This is PolyMC's program info which contains information about: + - Application name and logo (and branding in general) - Various URLs and API endpoints - Desktop file -- cgit From 19ecb1701e42eb277bfe5b185aec051a300f66dd Mon Sep 17 00:00:00 2001 From: txtsd Date: Wed, 13 Jul 2022 00:23:51 +0530 Subject: chore(markdown): MD031 Fenced code blocks should be surrounded by blank lines Signed-off-by: txtsd --- libraries/README.md | 1 + libraries/tomlc99/README.md | 5 +++++ nix/NIX.md | 1 + 3 files changed, 7 insertions(+) (limited to 'libraries/README.md') diff --git a/libraries/README.md b/libraries/README.md index 990d0597..e58f2273 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -57,6 +57,7 @@ A `legacy` and `onesix` launchers are available. * `onesix` can handle launching any Minecraft version, at the cost of some extra features `legacy` enables (custom window icon and title). Example (some parts have been censored): + ``` mod legacyjavafixer-1.0 mainClass net.minecraft.launchwrapper.Launch diff --git a/libraries/tomlc99/README.md b/libraries/tomlc99/README.md index 103024f0..8a144e70 100644 --- a/libraries/tomlc99/README.md +++ b/libraries/tomlc99/README.md @@ -102,6 +102,7 @@ general, all access functions on tables are named `toml_*_in(...)`. In the normal case, you know the key and its content type, and retrievals can be done using one of these functions: + ```c toml_string_in(tab, key); toml_bool_in(tab, key); @@ -113,6 +114,7 @@ toml_array_in(tab, key); ``` You can also interrogate the keys in a table using an integer index: + ```c toml_table_t* tab = toml_parse_file(...); for (int i = 0; ; i++) { @@ -127,11 +129,13 @@ for (int i = 0; ; i++) { TOML arrays can be deref-ed using integer indices. In general, all access methods on arrays are named `toml_*_at()`. To obtain the size of an array: + ```c int size = toml_array_nelem(arr); ``` To obtain the content of an array, use a valid index and call one of these functions: + ```c toml_string_at(arr, idx); toml_bool_at(arr, idx); @@ -150,6 +154,7 @@ call was successful. If so, you may proceed to read the value corresponding to the type of the content. For example: + ```c toml_datum_t host = toml_string_in(tab, "host"); if (host.ok) { diff --git a/nix/NIX.md b/nix/NIX.md index 39c67f57..047dd82f 100644 --- a/nix/NIX.md +++ b/nix/NIX.md @@ -1,6 +1,7 @@ # How to import To import with flakes use + ```nix { inputs = { -- cgit