From 87c38e9890d477cfc3677134dd474f2dfcdc6255 Mon Sep 17 00:00:00 2001 From: Richard J Hancock Date: Wed, 18 Sep 2024 15:36:01 -0500 Subject: [PATCH] Updated ReadMe to include text of new commands available --- ReadMe.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index ee213f3d80..3cae8c03ad 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -1,6 +1,7 @@ # MekHQ ## Table of Contents + 1. About 2. Status 3. Compiling @@ -17,6 +18,7 @@ can be loaded into MegaMek. For more details, see our [website](http://megamek.org/) and join our [Discord](https://discord.gg/XM54YH9396). ## 2. Status + | Type | MM Status | MML Status | MHQ Status | | ---- | --------- | ---------- | ---------- | | Latest Release | [![Release](https://img.shields.io/github/release/MegaMek/megamek.svg)](https://gitHub.com/MegaMek/megamek/releases/) | [![Release](https://img.shields.io/github/release/MegaMek/megameklab.svg)](https://gitHub.com/MegaMek/megameklab/releases/) | [![Release](https://img.shields.io/github/release/MegaMek/mekhq.svg)](https://gitHub.com/MegaMek/mekhq/releases/) | @@ -30,38 +32,56 @@ our [website](http://megamek.org/) and join our [Discord](https://discord.gg/XM5 Note that not everything has been implemented across the suite at this time, which will lead to gaps. ## 3. Compiling + 1) Install [Gradle](https://gradle.org/). 2) Follow the [instructions on the wiki](https://github.com/MegaMek/megamek/wiki/Working-With-Gradle) for using Gradle. +### 3.1 Style Guide + +When contributing to this project, please enable the EditorConfig option within your IDE to ensure some basic compliance with our [style guide](https://github.com/MegaMek/megamek/wiki/MegaMek-Coding-Style-Guide) which includes some defaults for line length, tabs vs spaces, etc. When all else fails, we follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). + +To help with additional checks, you can run the following commands within a terminal to see what is in compliance. There will be a lot of output while we clean up our code, so please only focus on the files with which you are editing. + +```shell +./gradlew editorconfigCheck +./gradlew check +``` + +The first ensures compliance with with the EditorConfig file, the other works with the Google Style Guide for most of the rest. ## 4. Support -For bugs, crashes, or other issues you can fill out a [GitHub issue request](https://github.com/MegaMek/mekhq/issues). +For bugs, crashes, or other issues you can fill out a [GitHub issue request](https://github.com/MegaMek/mekhq/issues). ## 5. License -``` + +```shell MekHQ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. MekHQ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with MekHQ. If not, see . ``` -Please see `MekHQ/license.txt` for more information. +Please see `MekHQ/license.txt` for more information. ## 6. Dependencies + These are all listed in the format "{ Project Name } ({ Optional - Alternate Project Name }) ({ Optional - Description }) : { Implemented Version } { Current Version Badge } : { Project Link }" ### 6.1. Internal Dependencies + MegaMek (MM) : N/A : https://github.com/MegaMek/megamek MegaMekLab (MML) : N/A : https://github.com/MegaMek/megameklab ### 6.2. Build Script Dependencies + launch4j : 2.5.4 [ ![launch4j](https://img.shields.io/maven-metadata/v.svg?colorB=007ec6&label=Gradle&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fedu%2Fsc%2Fseis%2Flaunch4j%2Fedu.sc.seis.launch4j.gradle.plugin%2Fmaven-metadata.xml)](https://plugins.gradle.org/plugin/edu.sc.seis.launch4j) : https://github.com/TheBoegl/gradle-launch4j grgit : 5.0.0 [![Maven Central](https://img.shields.io/maven-central/v/org.ajoberstar.grgit/grgit-gradle.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.ajoberstar.grgit%22%20AND%20a:%22grgit-gradle%22) : https://github.com/ajoberstar/grgit ### 6.3. Suitewide Dependencies + Flat Look and Feel (FlatLaf) (Expanded Themes, including Dark Mode) : 2.6 [![Maven Central](https://img.shields.io/maven-central/v/com.formdev/flatlaf.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.formdev%22%20AND%20a:%22flatlaf%22) : https://github.com/JFormDesigner/FlatLaf Jakarta XML Bind API (JAXB API) (XML Setup) : 4.0.0 [![Maven Central](https://img.shields.io/maven-central/v/jakarta.xml.bind/jakarta.xml.bind-api.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22jakarta.xml.bind%22%20AND%20a:%22jakarta.xml.bind-api%22) : https://eclipse-ee4j.github.io/jaxb-ri/ @@ -75,6 +95,7 @@ JUnit Jupiter (Unit Testing) : 5.9.1 [![Maven Central](https://img.shields.io/ma Mockito (Unit Testing) : 4.10.0 [![Maven Central](https://img.shields.io/maven-central/v/org.mockito/mockito-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.mockito%22%20AND%20a:%22mockito-core%22) : https://site.mockito.org/ ### 6.4. MegaMek Dependencies + Jackson (Jackson JSON) (JSON setup used for the internal graphical preference setup) : 2.14.1 [![Jackson](https://img.shields.io/maven-central/v/com.fasterxml.jackson.core/jackson-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.fasterxml.jackson.core%22%20AND%20a:%22jackson-core%22) : https://github.com/FasterXML/jackson-core SerialKiller (Java Deserialization Security) : Latest Develop : https://github.com/ikkisoft/SerialKiller @@ -89,6 +110,7 @@ Apache Freemarker : 2.3.31 [![Maven Central](https://img.shields.io/maven-centra Update Note : You'll need to also increase the version of Freemarker being actively used in MegaMek's TemplateConfiguration.java file. ### 6.5. MegaMekLab Dependencies + Apache PDFBox : 2.0.27 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.pdfbox/pdfbox.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.apache.pdfbox%22%20AND%20a:%22pdfbox%22) : https://pdfbox.apache.org/ Apache XMLGraphics Batik Bridge : 1.14 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.xmlgraphics/batik-bridge.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.apache.xmlgraphics%22%20AND%20a:%22batik-bridge%22) : https://xmlgraphics.apache.org/batik/ @@ -104,6 +126,7 @@ Apache XMLGraphics Batik SVGGen : 1.14 [![Maven Central](https://img.shields.io/ Apache XMLGraphics FOP : 2.7 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.xmlgraphics/fop.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.apache.xmlgraphics%22%20AND%20a:%22fop%22) : https://xmlgraphics.apache.org/fop/ ### 6.6. MekHQ Dependencies + Javax Vecmath : 1.5.2 [![Maven Central](https://img.shields.io/maven-central/v/javax.vecmath/vecmath.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22javax.vecmath%22%20AND%20a:%22vecmath%22) Joda Time : 2.12.2 [![Maven Central](https://img.shields.io/maven-central/v/joda-time/joda-time.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22joda-time%22%20AND%20a:%22joda-time%22) : https://www.joda.org/joda-time/