forked from BNYMellon/CodeKatas
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update SETUP.md based on siri's feedback
- Loading branch information
1 parent
1b74fbb
commit dafcf9a
Showing
1 changed file
with
12 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,16 @@ | ||
| ## Setting up the project | ||
|
|
||
| ### Tooling used | ||
| * [JDK 20.0.2+](https://jdk.java.net/20/) installed on your computer | ||
| * IntelliJ IDEA 2023.1+ or similar IDE for Java | ||
| ### Requirements | ||
| * [JDK 8](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html) installed on your computer | ||
| * [JDK 21](https://jdk.java.net/21/) installed on your computer | ||
| * [Maven 3.6.1+](https://maven.apache.org/download.cgi) installed on your computer | ||
| * [IntelliJ IDEA 2023.1+](https://www.jetbrains.com/idea/download/?section=windows) or similar IDE for Java | ||
|
|
||
| ### Initial setup | ||
| 1. Launch the project in the IDE (can be configured as a maven project, pointing to the root pom.xml) | ||
| ### Project setup | ||
| 1. Git clone the entire [code-katas](https://github.com/BNYMellon/CodeKatas) project from GitHub or download the project as a .zip file. | ||
| 2. Launch the project in the IDE as a maven project. You can find instructions on how to do that [here](https://www.jetbrains.com/idea/guide/tutorials/working-with-maven/importing-a-project/). | ||
| 3. To verify that the Java 8 module is set up correctly, run [CoffeeShopTest](/old-java-features/src/test/java/CoffeeShopTest.java) in the old-java-features module - the class should compile and all tests will pass. | ||
| 4. To verify that the Java 21 module is set up correctly, run [CoffeeShopTest](/new-java-features/src/test/java/CoffeeShopTest.java) in the new-java-features module - the class should compile but most tests will fail. | ||
|
|
||
| #### Test Java 8 module | ||
| 1. Verify that the module old-java-features uses JDK 8 | ||
| 2. Run [CoffeeShopTest](/old-java-features/src/test/java/CoffeeShopTest.java), all tests should pass | ||
| #### Test Java 21 module | ||
| 1. Verify that the module old-java-features uses JDK 20 | ||
| 2. Run [CoffeeShopTest](/bnymellon/codekata/coffeeshopkata/newjavafeatures/CoffeeShopTest.java), most tests should fail | ||
| #### Get started | ||
| * Make the failing tests in [CoffeeShopTest](/bnymellon/codekata/coffeeshopkata/newjavafeatures/CoffeeShopTest.java) pass by following and completing TODOs | ||
| ### Get started | ||
| * Follow the [README](coffee-shop-kata/README.md) for instructions on how to complete the kata. |