diff --git a/.gitpod.yml b/.gitpod.yml index d22e096..0ef2ca0 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -3,7 +3,7 @@ image: tasks: - init: sdk use java 16.0.1.hs-adpt - command: cd javafx-template; mvn compile + command: cd oysteikt-calc; mvn compile ports: # used by virtual desktop and vnc, supports JavaFX diff --git a/README.md b/README.md index 5d05188..bf64c49 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,9 @@ -[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/javafx-template) +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)][gitpod] # Javafx template -A repository with three variants of a javafx projects, with maven setup for Java 16 and JavaFX 16, and JUnit 5 (Jupiter) and TestFX for testing. +A repository with ~~three~~ `one` variants of a javafx projects, with maven setup for Java 16 and JavaFX 16, and JUnit 5 (Jupiter) and TestFX for testing. -To make the project(s) more interesting, it is the start of an [RPN](https://en.wikipedia.org/wiki/Reverse_Polish_notation) calculator (look for `// TODO`) markers). The core logic is almost implemented (in [Calc.java](javafx-template/src/main/java/app/Calc.java)), the fxml file (in [Calc.fxml](javafx-template/src/main/resources/app/App.fxml) is almost complete, but the controller class (in [CalcController.java](javafx-template/src/main/java/app/AppController.java) is pretty limited. And last, but not least, there is a TestFX-based test (in [CalcAppTest.java](javafx-template/src/test/java/app/AppTest.java), see the [README](javafx-template/src/test/java/app/README.md) for details about what it tests). - -## javafx-template - -Template for single-module, single-package javafx project. - -## packages-template - -Template for single-module, multi-package javafx project. - -## modules-template - -Template for multi-module, multi-package javafx project. +To make the project(s) more interesting, it is the start of an [RPN][rpn] calculator (look for `// TODO`) markers). The core logic is almost implemented (in [Calc.java][calc.java]), the fxml file (in [Calc.fxml][calc.fxml] is almost complete, but the controller class (in [CalcController.java][calc_controller.java] is pretty limited. And last, but not least, there is a TestFX-based test (in [CalcAppTest.java][calc_app_test.java], see the [README][readme] for details about what it tests). ## Trying it out @@ -24,3 +12,12 @@ All projects can be tried out by cd-ing into the corresponding folder and using - compile with `mvn compile` (after `cd oysteikt-calc` of course) - test with `mvn test` (it should fail until you complete the RPN calculator) - run with `mvn javafx:run` (it should open, but not work properly) + +[gitpod]: https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/students-2021/oysteikt +[rpn]: https://en.wikipedia.org/wiki/Reverse_Polish_notation + +[calc.java]: oysteikt-calc/src/main/java/app/Calc.java +[calc.fxml]: oysteikt-calc/src/main/resources/app/Calc.fxml +[calc_controller.java]: oysteikt-calc/src/main/java/app/CalcController.java +[calc_app_test.java]: oysteikt-calc/src/test/java/app/CalcAppTest.java +[readme]: oysteikt-calc/src/test/java/app/README.md \ No newline at end of file