From d051b78d256875d1cda065d2a18e0e28017a431d Mon Sep 17 00:00:00 2001 From: Arnaud Vergnet Date: Tue, 9 Mar 2021 11:36:55 +0100 Subject: [PATCH] add setup instructions --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index b12841a..ff8542c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,25 @@ A serious game about digital ethics. * Morgane Foussats * Nabil Moukhlis +## Setup + +First install [Godot following the official instructions.](https://godotengine.org/download/) + +Then clone this repo using: + +```bash +git clone https://git.etud.insa-toulouse.fr/vergnet/pir-serious-game-ethics.git +``` + +Open Godot, in the project manager, select `Import`, choose the `project.godot` file in previously the cloned repo then click `Import & Edit`. You can start editing the game! + +## Resources + +* [Godot Documentation](https://docs.godotengine.org/en/stable/) +* [Install the Git Godot extension](https://docs.godotengine.org/en/stable/getting_started/workflow/project_setup/version_control_systems.html) +* [Build and export the project](https://docs.godotengine.org/en/stable/getting_started/workflow/export/exporting_projects.html#) +* [EXP Godot Dialog System](https://github.com/EXPWorlds/Godot-Dialog-System) + ## Technologies This game is made with [Godot 3.2](https://godotengine.org), with the help of the [EXP Godot Dialog System](https://github.com/EXPWorlds/Godot-Dialog-System) by David Lipps.