diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..17610722 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,14 @@ +# Changes in this branch + +## This branch addresses the following issue: +### Time, ([issue #74](https://github.com/hhaslam11/Text-Fighter/issues/74) in the source hhaslam11/Text-Fighter repository, [issue #6](https://github.com/emmamickas/Text-Fighter/issues/6) in the forked emmamickas/Text-Fighter repository) + +## Desired modifications: +### Update the README.md file since because it hasn't been updated for a while. + +## Modified files: + * [README](https://github.com/hhaslam11/Text-Fighter/blob/master/README.md) + - Updated running instructions for IntelliJ and Gradle. + - Added a clip that shows game play. + - Updated contributors. + diff --git a/README.md b/README.md index 26914f3c..c7c4b766 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,15 @@ Open your command line/terminal, navigate to the downloaded .jar and run `java - Running ---------------- -To run this project in IntelliJ use the [these configurations](https://imgur.com/a/IpXX3Jy) +- **IntelliJ:** IntelliJ is the recommended IDE for this project. Follow these directions to setup the project in IntelliJ. + - To run this project in IntelliJ, add a Run/Debug configuration like [this configuration](https://imgur.com/a/IpXX3Jy). +- **Gradle:** To run this project just in your terminal/command prompt with gradle, just execute these command when in the Text-Fighter directory: + - gradle build + - gradle run + +Game Play +------------------ +To see a clip that shows a little about how the game is played, go [here](https://www.youtube.com/watch?v=Xrw0zHYXGFI). Modifications ------------------- @@ -53,11 +61,16 @@ Thanks for all your work! [docschorsch](https://github.com/docschorsch) [htn17](https://github.com/htn17) [Will-Estes](https://github.com/Will-Estes) -[CLEMENTJOHNSHAJI](https://github.com/CLEMENTJOHNSHAJI) +[CLEMENTJOHNSHAJI](https://github.com/CLEMENTJOHNSHAJI) [alfr3dosv](https://github.com/alfr3dosv) [xdvrx1](https://github.com/xdvrx1) -[R1ndT](https://github.com/R1ndT) -[SaurabhKukreja](https://github.com/SaurabhKukreja) +[R1ndT](https://github.com/R1ndT) +[SaurabhKukreja](https://github.com/SaurabhKukreja) +[emmamickas](https://github.com/emmamickas) +[rberlin-2019](https://github.com/rberlin-2019) + + + License --------------