Adding doc files

This commit is contained in:
David Négrier 2020-05-23 22:37:55 +02:00
parent 0251c054f9
commit fe39a5ab9e
2 changed files with 22 additions and 0 deletions

17
README.md Normal file
View File

@ -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.

5
index.html Normal file
View File

@ -0,0 +1,5 @@
<html>
<body>
This website contains a map for <a href="https://workadventu.re">Workadventu.re</a>
</body>
</html>