From 80173142fcff98b92a1f176d6c82c8df010d6765 Mon Sep 17 00:00:00 2001 From: antrikshdhand <> Date: Thu, 9 Nov 2023 16:48:50 +0800 Subject: [PATCH 1/2] Update README.md --- README.md | 87 +++++++++----------------------- docs/images/ChessMasterLogo.png | Bin 0 -> 1154 bytes 2 files changed, 23 insertions(+), 64 deletions(-) create mode 100644 docs/images/ChessMasterLogo.png diff --git a/README.md b/README.md index eccb82a5b3..e2baa8b37f 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,23 @@ -# Duke project template - -This is a project template for a greenfield Java project. It's named after Chess and Master. Given below are instructions on how to use it. - -## Setting up in Intellij - -Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version. - -1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project. -1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html). -1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below: - ``` - > Task :compileJava - > Task :processResources NO-SOURCE - > Task :classes - - > Task :Duke.main() - Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| - - What is your name? - ``` - Type some word and press enter to let the execution proceed to the end. - -## Build automation using Gradle - -* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file). -* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html). - -## Testing - -### I/O redirection tests - -* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script. - -### JUnit tests - -* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. -* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html). - -## Checkstyle - -* A sample CheckStyle rule configuration is provided in this project. -* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html). - -## CI using GitHub Actions - -The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR. - -## Documentation - -`/docs` folder contains a skeleton version of the project documentation. - -Steps for publishing documentation to the public: -1. If you are using this project template for an individual project, go your fork on GitHub.
- If you are using this project template for a team project, go to the team fork on GitHub. -1. Click on the `settings` tab. -1. Scroll down to the `GitHub Pages` section. -1. Set the `source` as `master branch /docs folder`. -1. Optionally, use the `choose a theme` button to choose a theme for your documentation. +
+
+ + Logo + +

ChessMaster

+

+ Chess finally makes it to your terminal. +
+ View User Guide + · + View Developer Guide + · + About Us +

+
+ +_ChessMaster_ is a command-line interface (CLI) chess game designed to make learning and training accessible for +beginners while offering an engaging experience for all skill levels. This simple and user-friendly chess simulator +provides a platform for novice players to build their skills and understanding of the game. + +This project was created for the _CS2113: Software Engineering and Object-Oriented Programming_ team project and +is programmed in 100% Java. \ No newline at end of file diff --git a/docs/images/ChessMasterLogo.png b/docs/images/ChessMasterLogo.png new file mode 100644 index 0000000000000000000000000000000000000000..59b802d857ec8ba462ee2b9fcc5c1586dfc29823 GIT binary patch literal 1154 zcmeAS@N?(olHy`uVBq!ia0y~yVEh8YEX+U=%O8h!0x8DgAa^Imn!UO9TGyO%anCu zW(gcvD&2oT(4ryzqf!-{{-dTFrYEO3pDnrW|J~+&(X3a$=AG#a`K}{2NyQTxS>Cel z`?Bj>h-=kHwV?3oRZ0sNFD~D@TuaExstPOj{M3E&!SlXO=f7|KBvj-g^@& zo!s5s;}5Wq2>1gnS?q6I z0t8={U$}TN-N}A`-<7ZRKa6TBF0J4B#{PFm|AySgx`}(9X?^-TKYfm2@QW9jKux$< z*6#fJ-aP8^``b?2|2ply@v7mk-7ELh8}`U-o%?0_`K0N|UzYA#vzVV(wpO*|%T%D1 z7cbsM;@n>HzV)Ti9iuSg=N=a?9^a=5^jE}h9-xXh(Tf%@?%#U;!UcqI?(-M@4|%&D zhTM-Zw}12ghnCy_3-4>Kul3C?34LbWVRvs|$hp1$#jUEgfi3E8@0+I!_UogCi_^Jf zfnaaNix)RRLFTS62UjNk;(fol{;!_$HQQd^7OAbX6$1vZRnSOYwdgfsFw1AEc_+n>SzBs>U-KNv#Z&yH!1sdFX;o@bmi|0E*A{gi;#gZ>uz+PT1U{w_bc6P7^^WQD? zwvV6pH1q2-+g|zh`87=W;&d61zd?xu2tXWQTCf-XyLtZS$Aww-%Y6Lj)+W601^NOR z+>3i*?Hpev_#~%1CrzN_OV`51=ZlZ0u{pZ0m$3R}gDSYvr~Xa7;!iu7U)o!~C*Cmp z^WgJ(r`h`RU# Date: Fri, 10 Nov 2023 20:29:32 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e2baa8b37f..0d19d4ed61 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,80 @@ beginners while offering an engaging experience for all skill levels. This simpl provides a platform for novice players to build their skills and understanding of the game. This project was created for the _CS2113: Software Engineering and Object-Oriented Programming_ team project and -is programmed in 100% Java. \ No newline at end of file +is programmed in 100% Java. + +## Getting started + +1. Ensure you have **Java 11 or above** installed in your system. + +2. Download the latest version of `ChessMaster.jar` from [here](https://github.com/AY2324S1-CS2113-T18-1/tp/releases). + +3. Open a terminal instance and navigate into the folder that contains the downloaded ChessMaster.jar file. + +```bash +cd PATH_TO_JAR_FILE +``` + +4. Run the jar application with the following command: + +```bash +java -jar ChessMaster.jar +``` + +You should be greeted by a welcome message from ChessMaster: +``` +_________________________________________________________________ + +Hey there, chess geek! You have stumbled upon the one and only: + ________ __ ___ __ + / ____/ /_ ___ __________ / |/ /___ ______/ /____ _____ + / / / __ \/ _ \/ ___/ ___/ / /|_/ / __ `/ ___/ __/ _ \/ ___/ + / /___/ / / / __(__ |__ ) / / / / /_/ (__ ) /_/ __/ / + \____/_/ /_/\___/____/____/ /_/ /_/\__,_/____/\__/\___/_/ + +where CHESS becomes an exciting journey of strategy and skill! +_________________________________________________________________ +``` + +## Usage + +A summary of user commands can be found in the table below: + +| Action | Format | +|---------------|------------------------------------| +| Move | `move [column][row] [column][row]` | +| Show moves | `moves [column][row]` | +| Show board | `show` | +| Rules | `rules` | +| Help | `help` | +| Pieces legend | `legend` | +| History | `history` | +| Step back | `stepback` | +| Abort | `abort` | + +Please visit our [User Guide](https://ay2324s1-cs2113-t18-1.github.io/tp/UserGuide.html) for further details on each +of these commands. + +## Contributing + +[![Contributors](https://img.shields.io/github/contributors/AY2324S1-CS2113-T18-1/tp?label=Contributors&style=flat-square)](https://github.com/AY2324S1-CS2113-T18-1/tp/graphs/contributors) +[![Commits](https://img.shields.io/github/commits-since/AY2324S1-CS2113-T18-1/tp/latest?style=flat-square&label=Commits%20since%20v2.0)](https://github.com/AY2324S1-CS2113-T18-1/tp/commits/master) +[![Issues](https://img.shields.io/github/issues/AY2324S1-CS2113-T18-1/tp?style=flat-square&label=Latest%20issues)](https://github.com/AY2324S1-CS2113-T18-1/tp/issues) +[![PRs](https://img.shields.io/github/issues-pr/AY2324S1-CS2113-T18-1/tp?style=flat-square&label=Pull%20requests)](https://github.com/AY2324S1-CS2113-T18-1/tp/pulls) + + +All contributions are greatly appreciated! If you have a suggestion that would make this better, +please fork the repo and create a pull request. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/branch-FeatureName`) +3. Commit your Changes (`git commit -m 'Add some FeatureName'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## Contact + +Please visit our [About Us](https://ay2324s1-cs2113-t18-1.github.io/tp/AboutUs.html) page for further contact +information. + +Project Link: [https://github.com/AY2324S1-CS2113-T18-1/tp](https://github.com/AY2324S1-CS2113-T18-1/tp) \ No newline at end of file