From fe39a5ab9e3a8db388bfa1c2b62b65c2293ff609 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=A9grier?= Date: Sat, 23 May 2020 22:37:55 +0200 Subject: [PATCH] Adding doc files --- README.md | 17 +++++++++++++++++ index.html | 5 +++++ 2 files changed, 22 insertions(+) create mode 100644 README.md create mode 100644 index.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3ac50f --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# WorkAdventure Map Starter Kit + +This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re). + +## Tools you will need + +In order to build your own map for WorkAdventure, you need: + +- the [Tiled editor](https://www.mapeditor.org/) software +- "tiles" (i.e. images) to create your map (this starter kit provides a good default tileset for offices) +- a web-server to serve your map (this starter kit proposes to use Github static pages as a web-server which is both free and performant) + +## Getting started + +On the [Github repository page](https://github.com/thecodingmachine/workadventure-map-starter-kit), +click the **"Use this template"** button. You will be prompted to enter a repository name for your map. + diff --git a/index.html b/index.html new file mode 100644 index 0000000..53f74ad --- /dev/null +++ b/index.html @@ -0,0 +1,5 @@ + + + This website contains a map for Workadventu.re + +