[Docs] Format with mdformat

HullSeals · Jun 3, 2024 · f03ef66 · f03ef66
1 parent 0b22a5f
commit f03ef66
Show file tree

Hide file tree

Showing 20 changed files with 1,061 additions and 837 deletions.
diff --git a/wiki/Acknowledgements-&-License.md b/wiki/Acknowledgements-&-License.md
@@ -1,50 +1,49 @@
-Disclaimer
---------
+## Disclaimer
+
 This app uses the “Companion” web API that Frontier originally supplied for their Elite Dangerous iOS app and now [support](https://forums.frontier.co.uk/showthread.php?t=218658&p=3371472#post3371472) for third-party apps. However this API could go away at some time in the future - in which case this app will cease to work.
 
+## Acknowledgements
+
+- Thanks to [Marginal](https://github.com/Marginal), the original developer, for all his hard work over the years.
+- “Elite: Dangerous” is © 1984 - 2019 Frontier Developments plc.
+- Thanks to Cmdr Zhixian Wu for the Chinese (Simplified) translation.
+- Thanks to Cmdrs CatfoodCZ, Mike Stix & DaraCZ for the Czech translation.
+- Thanks to Cmdr CoolBreeze for the Dutch translation.
+- Thanks to Cmdr FreezeFIN for the Finnish translation.
+- Thanks to [Cmdr Anthor](https://edsm.net/) for the French translation.
+- Thanks to Cmdr DragoCubX for keeping the German translation up to date.
+- Thanks to Cmdr Wormhole for the Hungarian translation.
+- Thanks to [Cmdr Koreldan](http://ed-map.eu/) for the Italian translation.
+- Thanks to Cmdr magni1200s for the Japanese translation.
+- Thanks to Cmdr bubis7 for the Latvian translation.
+- Thanks to Cmdr Amarok 73 for the Polish translation.
+- Thanks to Cmdrs Pivatto (@rafaelpivatto), Moraes (@wesleymoura), Wladimir JRC, and Warlord from Cobra Wing for the Portuguese (Brazil) translation.
+- Thanks to Carlos Oliveira (@idontcare1996) for the Portuguese (Portugal) translation.
+- Thanks to Shadow Panther for keeping the Russian translation up to date.
+- Thanks to Cmdr SuperBrain for the Serbian translation.
+- Thanks to Armando Ota for the Slovenian translation.
+- Thanks to Cmdr Mila Strelok for the Spanish translation.
+- Thanks to Taras Velychko for the Ukranian translation.
+- Thanks to Gurra for the Swedish translation.
+- Thanks to [Athanasius](https://github.com/Athanasius) for the port to Python
+  3, and taking over as principle maintainer mid-June 2020.
+- Thanks to [Ian Norton](https://github.com/inorton) for plugin support.
+- Thanks to [A_D](https://github.com/A-UNDERSCORE-D) for general
+  programming contributions, and being endlessly patient with Athanasius as he learned better Python practices.
+- Thanks to [Cmdr Anthor](https://github.com/EDSM-NET) and [James Muscat](https://github.com/jamesremuscat) for [EDDN](https://github.com/EDCD/EDDN/wiki).
+- Thanks to [Andargor](https://github.com/Andargor) for the idea of using the “Companion” interface in [edce-client](https://github.com/Andargor/edce-client).
+- Uses [Python Keyring Lib](https://github.com/jaraco/keyring) by Jason R. Coombs, Kang Zhang, et al.
+- Uses [Sparkle](https://github.com/sparkle-project/Sparkle) by [Andy Matuschak](http://andymatuschak.org/) and the [Sparkle Project](https://github.com/sparkle-project).
+- Uses [WinSparkle](https://github.com/vslavik/winsparkle/wiki) by [Václav Slavík](https://github.com/vslavik).
+- Uses [OneSky](http://www.oneskyapp.com/) for [translation management](https://marginal.oneskyapp.com/collaboration/project?id=52710).
+- Uses "Euro Caps" font by [Tom Oetken](https://www.dafont.com/profile.php?user=298681).
+
+## License
 
-Acknowledgements
---------
-* Thanks to [Marginal](https://github.com/Marginal), the original developer, for all his hard work over the years.
-* “Elite: Dangerous” is © 1984 - 2019 Frontier Developments plc.
-* Thanks to Cmdr Zhixian Wu for the Chinese (Simplified) translation.
-* Thanks to Cmdrs CatfoodCZ, Mike Stix & DaraCZ for the Czech translation.
-* Thanks to Cmdr CoolBreeze for the Dutch translation.
-* Thanks to Cmdr FreezeFIN for the Finnish translation.
-* Thanks to [Cmdr Anthor](https://edsm.net/) for the French translation.
-* Thanks to Cmdr DragoCubX for keeping the German translation up to date.
-* Thanks to Cmdr Wormhole for the Hungarian translation.
-* Thanks to [Cmdr Koreldan](http://ed-map.eu/) for the Italian translation.
-* Thanks to Cmdr magni1200s for the Japanese translation.
-* Thanks to Cmdr bubis7 for the Latvian translation.
-* Thanks to Cmdr Amarok 73 for the Polish translation.
-* Thanks to Cmdrs Pivatto (@rafaelpivatto), Moraes (@wesleymoura), Wladimir JRC, and Warlord from Cobra Wing for the Portuguese (Brazil) translation.
-* Thanks to Carlos Oliveira (@idontcare1996) for the Portuguese (Portugal) translation.
-* Thanks to Shadow Panther for keeping the Russian translation up to date.
-* Thanks to Cmdr SuperBrain for the Serbian translation.
-* Thanks to Armando Ota for the Slovenian translation.
-* Thanks to Cmdr Mila Strelok for the Spanish translation.
-* Thanks to Taras Velychko for the Ukranian translation.
-* Thanks to Gurra for the Swedish translation.
-* Thanks to [Athanasius](https://github.com/Athanasius) for the port to Python
-3, and taking over as principle maintainer mid-June 2020.
-* Thanks to [Ian Norton](https://github.com/inorton) for plugin support.
-* Thanks to [A_D](https://github.com/A-UNDERSCORE-D) for general
-programming contributions, and being endlessly patient with Athanasius as he learned better Python practices.
-* Thanks to [Cmdr Anthor](https://github.com/EDSM-NET) and [James Muscat](https://github.com/jamesremuscat) for [EDDN](https://github.com/EDCD/EDDN/wiki).
-* Thanks to [Andargor](https://github.com/Andargor) for the idea of using the “Companion” interface in [edce-client](https://github.com/Andargor/edce-client).
-* Uses [Python Keyring Lib](https://github.com/jaraco/keyring) by Jason R. Coombs, Kang Zhang, et al.
-* Uses [Sparkle](https://github.com/sparkle-project/Sparkle) by [Andy Matuschak](http://andymatuschak.org/) and the [Sparkle Project](https://github.com/sparkle-project).
-* Uses [WinSparkle](https://github.com/vslavik/winsparkle/wiki) by [Václav Slavík](https://github.com/vslavik).
-* Uses [OneSky](http://www.oneskyapp.com/) for [translation management](https://marginal.oneskyapp.com/collaboration/project?id=52710).
-* Uses "Euro Caps" font by [Tom Oetken](https://www.dafont.com/profile.php?user=298681).
-
-License
--------
 Copyright © 2015-2019 Jonathan Harris, 2020 EDCD.
 
 Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-2.0.html) version 2 or later.
 
-Contributing
----
-If you think you have a good idea for extending or improving EDMC then please read [Contributing.md](https://github.com/EDCD/EDMarketConnector/blob/main/Contributing.md).
+## Contributing
+
+If you think you have a good idea for extending or improving EDMC then please read [Contributing.md](https://github.com/EDCD/EDMarketConnector/blob/main/Contributing.md).
diff --git a/wiki/Automatic Builds.md b/wiki/Automatic Builds.md
@@ -7,23 +7,25 @@ you can build the EDMarketConnector installer using GitHub actions.
 ## Initiating a workflow run
 
 ### Automatically on tag push
+
 Once you are sure you have a branch all ready for release as a new version you
-should be adding a `Release/<semantic version>` tag at that HEAD.  Pushing 
+should be adding a `Release/<semantic version>` tag at that HEAD.  Pushing
 such a tag to GitHub will cause the
 [the GitHub Windows Build Action file](../.github/workflows/windows-build.yml)
 to build an installer and create a draft release, with the pre-release box
-pre-ticked.  This ensures you don't accidentally create a new non-pre 
+pre-ticked.  This ensures you don't accidentally create a new non-pre
 release which will always become the target of the `latest` shortcut on GitHub.
 
-You can monitor such an auto-build from the Actions tab on GitHub.  If it 
-completes successfully then check the Releases tab on GitHub for the draft 
+You can monitor such an auto-build from the Actions tab on GitHub.  If it
+completes successfully then check the Releases tab on GitHub for the draft
 that was created.
 
 See [Releasing.md#Distribution](Releasing.mdistribution) for details on
 how to fully publish an automatic release so that running EDMarketConnector.exe
 clients pick it up as an update.
 
 ### Manually
+
 Starting a workflow run is done from the Actions tab at the top of the main
 GitHub UI
 
@@ -33,20 +35,20 @@ branch is the version that will be used for the build (e.g. for different
 python versions)
 
 1. Select the Actions tab at the top of the main GitHub interface
-2. Select the `Build EDMC for Windows` workflow on the left
-3. Click the "Run workflow" button at the right side of the blue banner
+1. Select the `Build EDMC for Windows` workflow on the left
+1. Click the "Run workflow" button at the right side of the blue banner
    1. Select the branch you want to build
-   2. Click the "Run Workflow"
+   1. Click the "Run Workflow"
 
 ## Downloading built installer files
 
 When the workflow is (successfully) completed, it will upload the msi file it
 built as a "Workflow Artifact". You can find the artifacts as follows:
 
 1. Select `All workflows` on the left
-2. Select the `Build EDMC for Windows` action
-3. Select your build (probably the top one)
-4. Find the `Built Files` artifact
+1. Select the `Build EDMC for Windows` action
+1. Select your build (probably the top one)
+1. Find the `Built Files` artifact
 
 Within the `Built Files` zip file is the installer msi
 

diff --git a/wiki/Code-Signing-and-EDMC.md b/wiki/Code-Signing-and-EDMC.md
@@ -1,10 +1,12 @@
 # Code Signing
-As of version 5.10.2, we now sign our releases of the EDMC installer. Code signing is a method where we can digitally sign our executables and scripts to confirm the software has not been altered since it was signed. Due to how the code signing options we have available work, the automatically built EXE must be downloaded to the developer's machine, signed, and uploaded back to GitHub. This is the only modification that has been made. 
+
+As of version 5.10.2, we now sign our releases of the EDMC installer. Code signing is a method where we can digitally sign our executables and scripts to confirm the software has not been altered since it was signed. Due to how the code signing options we have available work, the automatically built EXE must be downloaded to the developer's machine, signed, and uploaded back to GitHub. This is the only modification that has been made.
 
 This code signing allows us a greater level of confidence in distributions of EDMC, gives various AntiVirus products greater confidence in the legitimacy of the tool (reducing the number of false positive detections), and also assists in ensuring our code is not modified from the point of signing onward.
 
 ## How does Code Signing impact EDMC?
-Code Signing for the main EDMC releases will not impact the average user's experience with EDMC installers. Installations from the source files are not impacted by this change. 
+
+Code Signing for the main EDMC releases will not impact the average user's experience with EDMC installers. Installations from the source files are not impacted by this change.
 
 For users who use signed installers, the normal Windows UAC authentication prompt will include additional information about the signed code. A signed release will look something like this:
 
@@ -15,4 +17,5 @@ Users who inspect the installer exe file will also be able to see a digital sign
 ![image](https://github.com/EDCD/EDMarketConnector/assets/26337384/de72dc25-3f97-41bf-bb88-c07ded5b19d6)
 
 ## Opting Out
+
 Some users may be uncomfortable using a signed release and prefer to use unsigned releases which are pure automatic builds. We absolutely understand these concerns! These WILL BE MADE AVAILABLE on the GitHub release page for every release going forward. This will require manual updates and will not be distributed through the WinSparkle update system.
diff --git a/wiki/Git-Using-Main-Branch.md b/wiki/Git-Using-Main-Branch.md
@@ -14,12 +14,12 @@ should follow these steps to migrate:
 
 These steps are:
 
-1.    Go to the master branch
-1.    Rename master to main locally
-1.    Get the latest commits from the server
-1.    Remove the link to origin/master
-1.    Add a link to origin/main
-1.    Update the default branch to be origin/main
+1. Go to the master branch
+1. Rename master to main locally
+1. Get the latest commits from the server
+1. Remove the link to origin/master
+1. Add a link to origin/main
+1. Update the default branch to be origin/main
 
 See
 [Contributing.md](https://github.com/EDCD/EDMarketConnector/blob/main/Contributing.md)