Issue #461 Update the documentation

README.md

@@ -7,17 +7,21 @@
 ![GitHub contributors](https://img.shields.io/github/contributors/prmr/JetUML)
 
 
-A lightweight desktop application for interactively creating and editing diagrams in the Unified Modeling Language. JetUML supports the sketching of software design ideas with a minimum of fuss. Diagrams can be saved in JSON, exported to popular image formats, and copied to the system clipboard for integration with other tools. Supports class diagrams, sequence diagrams, state diagrams, object diagrams, and use case diagrams. If you find this tool useful please **star the repo**.
+A lightweight desktop application for interactively creating and editing diagrams in the Unified Modeling Language. JetUML supports the sketching of software design ideas with a minimum of fuss. Diagrams can be saved in JSON, exported to popular image formats, and copied to the system clipboard for integration with other tools. Supports class diagrams, sequence diagrams, state diagrams, object diagrams, and use case diagrams. 
 
 ![JetUML Class Diagram](docs/banner.png)
 
 ## Download and Installation
 
-JetUML is available both as a self-contained application and as a Java archive file under the terms of the [GNU General Public License v3](https://www.gnu.org/licenses/gpl.html). Download the application from the [latest release](https://github.com/prmr/JetUML/releases) page and if necessary see the [installation guide](docs/install.md). Users upgrading from a previous version might want to peek at the [compatibility guide](docs/compatibility.md)
+JetUML is available both as a self-contained application and as a Java archive file under the terms of the [GNU General Public License v3](https://www.gnu.org/licenses/gpl.html). Download the application from the [latest release](https://github.com/prmr/JetUML/releases) page and if necessary see the [installation guide](docs/install.md).
 
-## Privacy Policy and Feedback
+## Privacy Policy
 
-JetUML does not collect any information. We rely on you to estimate usage levels and receive feedback. If you use JetUML, please **star the repo**. If you use the project for teaching or research, please also [let us know](mailto:[email protected]). 
+JetUML does not collect any information, personal or otherwise. The application only accesses the network to open web pages via the commands in the Help menu.
+
+## Support JetUML
+
+JetUML is entirely free. You can support the project by starring this repo and by writing an endorsement ([contact us](mailto:[email protected])).
 
 ## Documentation
 

docs/developers.md

@@ -26,10 +26,11 @@ Starting with Release 3.0 JetUML needs to be packaged as a self-contained applic
 
 ### Windows
 
-Run this from the git repo root (where `FXMODS` points to the JavaFX mods directory)
+Run this from the git repo root (where `FXMODS` points to the JavaFX mods directory, e.g.,):
 
 ```
-jpackage --module-path %FXMODS%;bin\jetuml --add-modules jetuml --module jetuml/ca.mcgill.cs.jetuml.JetUML --app-version 3.0 --icon docs\JetUML.ico --win-shortcut --win-dir-chooser
+set FXMODS="C:\local\Java\javafx-jmods-17.0.2"
+jpackage --module-path %FXMODS%;bin\jetuml --add-modules jetuml --module jetuml/ca.mcgill.cs.jetuml.JetUML --app-version 3.4 --icon docs\JetUML.ico --win-shortcut --win-dir-chooser
 ```
 
 ### Mac
@@ -38,7 +39,7 @@ jpackage --module-path %FXMODS%;bin\jetuml --add-modules jetuml --module jetuml/
 Run this from the git repo root (where `PATH_TO_FX_MODS` points to the JavaFX mods directory)
 
 ```
-$JAVA_HOME/bin/jpackage -n JetUML --module-path $PATH_TO_FX_MODS:bin/jetuml --add-modules jetuml --module jetuml/ca.mcgill.cs.jetuml.JetUML --app-version 3.0 --module jetuml/ca.mcgill.cs.jetuml.JetUML --type pkg --icon docs/JetUML.icns
+$JAVA_HOME/bin/jpackage -n JetUML --module-path $PATH_TO_FX_MODS:bin/jetuml --add-modules jetuml --module jetuml/ca.mcgill.cs.jetuml.JetUML --app-version 3.4 --module jetuml/ca.mcgill.cs.jetuml.JetUML --type pkg --icon docs/JetUML.icns
 ```
 
 ### Linux

docs/install.md

@@ -7,17 +7,19 @@
 Starting with Release 3.0, JetUML is distributed in two formats:
 
 * **Self-contained application:** A large OS-specific download that must be installed on your system, but that does not require the Java platform.
-* **Thin Jar:** A small Java archive (jar) file that does _not_ include any of the dependencies. This option is available for experienced users who just want to download a tiny file and run it from the command-line. The thin jar is OS-independent but requires to have Java 14 or later *and* JavaFX 14 or later installed. 
+* **Thin Jar:** A small Java archive (jar) file that does _not_ include any of the dependencies. This option is available for experienced users who just want to download a tiny file and run it from the command-line. The thin jar is OS-independent but requires to have Java 17 or later *and* JavaFX 17 or later installed. 
 
 ### Self-Contained Application
 
 * Download the file `JetUML-<Version>-<OS>.<ext>` that corresponds to your operating system from the [latest release page](https://github.com/prmr/JetUML/releases).
 
 * Run or install the file as customary on the appropriate operating system. You will be asked where to extract the application and a shortcut will be added to the desktop. 
 
+* If you are upgrading from a previous version, you can install the new application on top of the older version. See the [compatibility guide](compatibility) for information on loading diagram saved using older versions of JetUML.
+
 ### Thin Jar
 
-*This format requires that you have both [Java](https://openjdk.java.net/) and [JavaFX](https://openjfx.io/) version 14 or above running on your system.* 
+*This format requires that you have both [Java](https://openjdk.java.net/) and [JavaFX](https://openjfx.io/) version 17 or above running on your system.* 
 
 Download file `JetUML-<Version>.jar` from the [latest release page](https://github.com/prmr/JetUML/releases), to a local directory. 
 
@@ -30,7 +32,7 @@ javaw --module-path "PATH_TO_JAVAFX_LIB" --add-modules=javafx.controls,javafx.sw
 Where `PATH_TO_JAVAFX_LIB` is the full path to the `lib` directory of the `javafx` installation and `JETUML_FILE` is the path to the JetUML jar downloaded. For example:
 
 ```shell
-javaw --module-path "C:\Program Files\Java\javafx-sdk-11.0.2\lib" --add-modules=javafx.controls,javafx.swing,java.desktop,java.prefs -jar JetUML-3.0.jar
+javaw --module-path "C:\local\Java\javafx-sdk-17.0.2\lib" --add-modules=javafx.controls,javafx.swing,java.desktop,java.prefs -jar JetUML-3.4.jar
 ```
 
 ## Legacy