diff --git a/LICENSE.md b/LICENSE.txt similarity index 100% rename from LICENSE.md rename to LICENSE.txt diff --git a/README.md b/README.md index e9aa587..5c7ed2e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ View QM Revision History at: https://www.state-machine.com/qm/history.html --------------------------------------------------------------------------- -# Documentation +# Documentation The online HTML documention for the **latest** version of QM is located at: https://www.state-machine.com/qm/ @@ -25,40 +25,40 @@ QM is available for Windows 32/64-bit, Linux 64-bit, and MacOS. https://www.state-machine.com/qm/ --------------------------------------------------------------------------- -# Downloading and Installing QM +# Downloading and Installing QM The most recommended way of obtaining QM is by downloading the [QP-bundle](https://www.state-machine.com/#Downloads), which includes QM and also all [QP frameworks](https://www.state-machine.com/products/) and the [QTools collection](https://www.state-machine.com/products/). The main advantage of obtaining QM bundled together like that is that you -get all components, tools and examples ready to go. - +get all components, tools and examples ready to go. + > NOTE: [QP-bundle](https://www.state-machine.com/#Downloads) is the **most recommended** way of downloading and installing QM. However, if you are allergic to installers and GUIs or don't have administrator privileges you can also **download and install QM separately** -as described below. - +as described below. + > CAUTION: If you have any previous version of QM installed on your system, please *uninstall* it before installing the new version. - + --------------------------------------------------------------------------- ### Installing QM on Windows (32/64-bit) Go to the [QM releases](https://github.com/QuantumLeaps/qm/releases) and download the QM zip archive for Windows (`qm_-win32.zip`). You can unzip the archive into any directory, although the `C:\qp\` folder is the -recommended default. - +recommended default. + > NOTE: It is generally not recommended to install QM in such standard locations as "Program Files" or "Program Files (x86)", because these directories have access limitations and don't allow you to modify the -QM Style Sheet (`qm.qss`) or the model templates. - +QM Style Sheet (`qm.qss`) or the model templates. + If you wish, after the installation, you could create a desktop shortcut for QM and you can also associate QM model files (`*.qm` and `*.qmp`) with the QM application (using the standard Windows Explorer and -"Open With" popup menu). - +"Open With" popup menu). + To uninstall QM you simply delete the installation directory. --------------------------------------------------------------------------- @@ -66,15 +66,15 @@ To uninstall QM you simply delete the installation directory. Go to the [QM releases](https://github.com/QuantumLeaps/qm/releases) and download the QM zip archive for Linux (`qm_-linux64.zip`). You can unzip the archive into any directory, although the `~/qp/` folder is the -recommended default. - +recommended default. + After unzipping the archive, go to the `qm/bin/` directory and make sure that the `qm` executable and the `qm.sh` shell script have executable permissions. You can either do this with your desktop's file manager or at the command line, type: ```sh -chmod u+x qm +chmod u+x qm chmod u+x qm.sh ``` diff --git a/version-5.0.0 b/version-5.0.0 deleted file mode 100644 index d8d1674..0000000 --- a/version-5.0.0 +++ /dev/null @@ -1,2 +0,0 @@ -QM 5.0.0 -2020-03-31 diff --git a/version-5.0.1 b/version-5.0.1 new file mode 100644 index 0000000..27e0cc1 --- /dev/null +++ b/version-5.0.1 @@ -0,0 +1,2 @@ +QM 5.0.1 +2020-04-22