diff --git a/README.md b/README.md index 3a89379..b40ac9f 100644 --- a/README.md +++ b/README.md @@ -132,13 +132,16 @@ Before we began implementing the program, we followed the [Five Design Sheet Met # Installation -TODO: Write about how to install the project +To install the project, simply download the [latest release](https://github.com/rikkeaas/strangevis-moviemaker/releases) which contains the complete source code for the project, in addition to all prebuilt dependencies and binaries for Windows. + +# Running + +To run the project, un-zip the downloaded folder from the previous step. After this, a folder named `Release` will be created, and this contains the executable file `strangevis-moviemaker.exe`. Double Click this executable, and the project will start running. # Usage `Strangevis Movie Maker` is highly interactive with loads of different features. Here is a list of how to use every single one of them. -TODO: Write about how to run the project ## Keyboard Shortcuts and Mouse Actions @@ -200,10 +203,6 @@ Items in the Advanced menu: ![Skeleton](assets/app_preview_2.png) -# Ackowledgements - -TODO: Might have this field in the README - # License Copyright © 2021, [Rikke Aas](https://github.com/rikkeaas) and [Christian Hein](https://github.com/chrhein). Written as a part of the [INF252](https://vis.uib.no/courses/inf252/) course at the [University of Bergen](https://github.com/uib). Released under the GPLv3 License.