diff --git a/README.md b/README.md index c3ac50f..0608eca 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,41 @@ In order to build your own map for WorkAdventure, you need: 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. +![](docs/create_repo.png) + +Be sure to keep the repository "Public". + +In your newly created repository, click on the **Settings tab** and scroll down to the **GitHub Pages** section. +Then select the **master** branch. + +![](docs/github_pages.png) + +Wait a few minutes a Github will deploy a new website with the content of the repository. +The address of the website is visible in the "GitHub Pages" section. + +![](docs/website_address.png) + +Click on the link. You should be redirected directly to WorkAdventure, on your map! + +## Customizing your map + +Your map is now up and online. You need to customize it. + +### Cloning the map + +Start by cloning the map. If you are used to Git and GitHub, simply clone the map +to your computer using your preferred tool and jump to the next chapter. + +If you are new to Git, cloning the map means downloading the map to your computer. +To do this, you will need Git, or a Git compatible tool. Our advice is to use +[GitHub Desktop](https://desktop.github.com/). + +TODO: test and continue + +### Loading the map in Tiled + +TODO + +### Pushing the map + +When your changes are ready, you need to "commit" and "push" the changes back to GitHub. diff --git a/docs/create_repo.png b/docs/create_repo.png new file mode 100644 index 0000000..552081e Binary files /dev/null and b/docs/create_repo.png differ diff --git a/docs/github_pages.png b/docs/github_pages.png new file mode 100644 index 0000000..c6c8b06 Binary files /dev/null and b/docs/github_pages.png differ diff --git a/docs/website_address.png b/docs/website_address.png new file mode 100644 index 0000000..d994e9f Binary files /dev/null and b/docs/website_address.png differ