Adding a part of the documentation
This commit is contained in:
parent
fe39a5ab9e
commit
0e0649b3ec
38
README.md
38
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),
|
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.
|
click the **"Use this template"** button. You will be prompted to enter a repository name for your map.
|
||||||
|
|
||||||
|

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

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

|
||||||
|
|
||||||
|
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.
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 158 KiB |
Binary file not shown.
After Width: | Height: | Size: 175 KiB |
Binary file not shown.
After Width: | Height: | Size: 44 KiB |
Loading…
Reference in New Issue