diff --git a/readme.md b/readme.md index 48e5bbc..cbf50d0 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,20 @@ # Speedometer This is a simple mod for forge and fabric that displays your current speed -This mod is a newer version of [speedometer-forge](https://github.com/zaze06/speedometer-forge) +## Compile your own version? +1. Download source code + * Run `git clone https://github.com/zaze06/Speedometer` + * Download the source code from github page [master.zip](https://github.com/zaze06/Speedometer/archive/refs/heads/master.zip) + * unzip the folder +2. Open the folder +3. Run `gradlew build`(Windows cmd) or `./gradlew build`(Linux, MacOS, Windows powershell) +4. the compiled version will be in + * Fabic: `fabric/build/libs` + * Forge: `forge/build/libs` + + +# This mod is a newer version of [speedometer-forge](https://github.com/zaze06/speedometer-forge) ## Changes from old forge version? This was just a project I choose for trying the Architectury API for abstraction. -So changes are that now Architectury APi is required for this mod to work \ No newline at end of file +So changes are that now Architectury APi is required for this mod to work