diff --git a/README.md b/README.md index 4aa3942a19fc6627798710b3fe35aff6ad341350..e7c19fc5ab7363341e545b98383326023144a533 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # UFrameIT -say what uframeit is in one sentence, link to official website. say what this repo contains. +The FrameIT project builds a Framework for developing Serious Games by combining Virtual Worlds with Mathematical Knowledge Management. +The UFrameIT framework uses the Unity game engine with the [MMT](https://uniformal.github.io/) system. +This repository contains the Unity project, which currently includes the framework itself and a demo game. For more information about the project, please visit <https://uframeit.github.io/> @@ -12,15 +14,15 @@ Just download our latest release: <https://github.com/UFrameIT/UFrameIT/releases First, you have to set up a development environment: -1. Install [Unity](https://unity3d.com/de/get-unity/download) 2019.4.x (LTS). We periodically update to the latest LTS version. Currently, any 2019.4 version should work; you can safely ignore any version warnings popping up. +1. Install [Unity](https://unity3d.com/de/get-unity/download) 2019.4.x (LTS) via the Unity Hub. We periodically update to the latest LTS version. Currently, any 2019.4 version should work; you can safely ignore any version warnings popping up. 2. Clone this repository: `git clone https://github.com/UFrameIT/UFrameIT.git` 3. Get the [FrameIT archives](https://github.com/UFrameIT/archives), make sure to update the submodules with this [script](https://gist.github.com/ComFreek/dcadfec0214d87e9ad3268e61479d05b) 4. Install [IntelliJ IDEA](https://www.jetbrains.com/de-de/idea/) 5. Clone [MMT](https://github.com/UniFormal/MMT/tree/devel), which also contains the [FrameIT MMT server](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt), on the *devel* branch: `git clone --branch devel https://github.com/UniFormal/MMT.git` -and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the [Server Component] +and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the Server Component ### Running -1. Start Unity and open the project in this repo? +1. Open the Unity Hub and add the folder where you have cloned this repository. Then, you can directly open the project in the hub. 2. Follow the [FrameIT MMT server's usage guide](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt) for how to start the FrameIT MMT server 3. Run the game in unity