caskd
/
kami-blue
forked from RepoMirrors/kami-blue
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

collapse sections in readme and add improvements to close #35

This commit is contained in:
S-B99 2019-10-25 14:08:03 -04:00
parent 4e64d652f9
commit 3d630a7829
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -126,7 +126,13 @@ If you have an issue or problem and it's not listed there, please [open a new is
</details> </details>
### Building ## Building
<details>
<summary>Click to see building instructions</summary>
***
#### Linux #### Linux
You can build by running these commands (without the <>) in a terminal. You can build by running these commands (without the <>) in a terminal.
``` ```
@ -167,8 +173,17 @@ If you prefer copying it manually, find a file in `build/libs` called `KAMI-<kam
Note: This assumes your minecraft folder is in the default location under your %appdata% folder. Note: This assumes your minecraft folder is in the default location under your %appdata% folder.
***
</details>
## Contributing ## Contributing
<details>
<summary>Click to see how to contribute</summary>
***
You are free to clone, modify KAMI and KAMI Blue and make pull requests as you wish. To set up your development environment, make use of the following commands: You are free to clone, modify KAMI and KAMI Blue and make pull requests as you wish. To set up your development environment, make use of the following commands:
On GNU/Linux, run `chmod +x gradlew` and for the following commands use `./gradlew` instead of `gradlew.bat` On GNU/Linux, run `chmod +x gradlew` and for the following commands use `./gradlew` instead of `gradlew.bat`
@ -192,6 +207,23 @@ If you have gradle related issues with either of these force your gradle version
If you do not wish to run from an IDE, use `gradlew.bat runClient` to run KAMI Blue. If you do not wish to run from an IDE, use `gradlew.bat runClient` to run KAMI Blue.
***
</details>
## How this improves over KAMI (Red)
<details>
<summary>Click to see new features and improvements</summary>
- NoFall Bucket Mode picks up the water bucket after
- Better mcmod.info with more information
- Future compatibility
- Auto32k
- 32k options for Aura
- Continued development
</details>
## Thank you ## Thank you
[zeroeightysix](https://github.com/zeroeightysix) for the original [KAMI](https://github.com/zeroeightysix/KAMI) [zeroeightysix](https://github.com/zeroeightysix) for the original [KAMI](https://github.com/zeroeightysix/KAMI)