From f1c150143a97aba9c21ebb6fec9b89644f558232 Mon Sep 17 00:00:00 2001 From: mattmaniak <72657016+mattmaniak@users.noreply.github.com> Date: Fri, 5 Jul 2024 11:40:35 +0200 Subject: [PATCH] Fix grammar typos and reorganize contributing guide according to the PR --- README.md | 9 +++++---- src/game-support/README.md | 4 +--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ed0152a..4e4cab3 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,8 @@ Documentation for Whisky. - Ensure proper grammar, capitalization, spelling, spacing, and general professionalism. Jokes and such are allowed, but lets prioritize helping others before all else. - Ensure accuracy. Don't upload misleading information, false reports, guesses, or improper research. - Cite your sources. Found a guide from somewhere else? Found a solution or other thing online? Provide a link in your page. This isn't a requirement that's going to get your PR rejected, but simply one that future-proofs things and ensures that if a game suddenly breaks, we can check our sources and see if there are any updates to the solutions found. - - You can add games that already have a native macOS port. Those ports are sometimes poorly optimized and or full of bugs so it could be better solution to play a Windows version of a game via Whisky. Even if Steam provides a macOS port of a game it may be not a standard on other game stores, ie. GOG. + - You can add games that already have a native macOS port. Those ports are sometimes poorly optimized and or full of bugs so it could be better solution to play a Windows version of a game via Whisky. Even if Steam provides a macOS port of a game it may be not a standard on other game stores, ie. GOG. + - Write whether a game installs without any errors and opens properly according to the parameters in an example below. Set `opens` to `Yes` only if a game launches successfully to it's default screen, eg. main menu or initial gameplay if it lacks a main menu. Any crash, freeze or error before this breakpoint means that the game does not open and it should be filled with `opens=No`. - Add status ratings to your game based on the following scale. We leave this up to general author interpretation, but please make sure you're still following these general guidelines: | Status | Description | @@ -38,7 +39,7 @@ Documentation for Whisky. | Gold | Game can be configured to run perfectly and without any defects. | | Silver | Game requires some configuration to run and or has minor defects. | | Bronze | Game is very difficult to get working and or has severe in-game issues that limit playability. | - | Garbage | Game does not work at all or it is not playable due to in-game issues. | + | Garbage | Game does not work at all or it's playability is quite limited due to the technical issues. | 1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game. - Format your file in all lowercase, using only alphabetical, numerical, and dash characters, and use abbreviations where possible. i.e: @@ -48,7 +49,7 @@ Documentation for Whisky. Star Wars Jedi: Fallen Order -> sw-fallen-order.md Geometry Wars 3: Dimensions Evolved -> gw3-dimensions-evolved.md ``` -2. Add the following template to your markdown file. Write whether a game installs without any errors and opens properly according to the parameters in an example below. Set `opens` to `Yes` only if a game launches successfully to it's default screen, eg. main menu or initial gameplay if it lacks a main menu. Any crash, freeze or error before this breakpoint means that the game does not open and it should be filled with `opens=No`. +2. Add the following template to your markdown file. ``` # @@ -58,7 +59,7 @@ Documentation for Whisky. ``` {{#template ../templates/steam.md id=}} ``` - Ensure that you're replacing the `<>` tags with the proper values in order to comply with the wiki layout. If a game is no longer available on Steam or it is not available there at all then provide a valid link to the store or to the download page. **Entering pirate, potentially copyright-breaking and non-store executables links is disallowed.** Whisky was created to run regular Windows games without any codebase alteration. Below is an example of what [Star Wars Jedi: Fallen Order](https://docs.getwhisky.app/game-support/sw-fallen-order.html) will look like, and what it will look like on the wiki. + Ensure that you're replacing the `<>` tags with the proper values in order to comply with the wiki layout. Below is an example of what [Star Wars Jedi: Fallen Order](https://docs.getwhisky.app/game-support/sw-fallen-order.html) will look like, and what it will look like on the wiki. ``` # Star Wars Jedi: Fallen Order diff --git a/src/game-support/README.md b/src/game-support/README.md index 74c10bc..e35337f 100644 --- a/src/game-support/README.md +++ b/src/game-support/README.md @@ -16,6 +16,4 @@ title is partially left to the article author, but some general guidelines apply | Gold | Game can be configured to run perfectly and without any defects. | | Silver | Game requires some configuration to run and or has minor defects. | | Bronze | Game is very difficult to get working and or has severe in-game issues that limit playability. | -| Garbage | Game does not work at all or it is not playable due to in-game issues. | - - +| Garbage | Game does not work at all or it's playability is quite limited due to the technical issues. |