Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
* Docs update.

* Docs update.
  • Loading branch information
iwatkot authored Feb 16, 2025
1 parent 5e033d1 commit eb5f3e5
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ Using it is easy and doesn't require any guides. Enjoy!
⚙️ Advanced settings: enabled.
🖼️ Texture dissolving: enabled.
Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>

📹 Check out the [video tutorial](https://www.youtube.com/watch?v=1AHGIxTxSBM) on how to install Docker and use the Docker version.

You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:

1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
Expand Down
5 changes: 5 additions & 0 deletions docs/FAQ_docker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## Frequently Asked Questions about Docker

📹 Learn how to install Docker and launch the tool locally in the video tutorial.

[![YouTube tutorial](https://github.com/user-attachments/assets/c86ee51f-d787-4ffe-9da9-6c8d938b05ac)](https://youtu.be/1AHGIxTxSBM)


In this section, you will find anwers to the most frequently asked questions about usage of the Docker version of the app. Most of those questions are not related to the app, but to the Docker itself. Please, before asking a question, or opening an issue, check if the answer is already here. Thank you!


Expand Down
2 changes: 1 addition & 1 deletion docs/step_by_step.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ By default, the generator will add all the fields from the [OpenStreetMap](https
ℹ️ Learn more about it in the [Fields](https://github.com/iwatkot/maps4fs/blob/main/docs/fields.md) document.

### 10. 📚 Add farmlands
The generator will automatically add farmlands to the map. But if you need, you can add or adjust them manually in the Giants Editor.
The generator will automatically add farmlands to the map. But if you need, you can add or adjust them manually in the Giants Editor.
ℹ️ Learn more about it in the [Farmlands](https://github.com/iwatkot/maps4fs/blob/main/docs/farmlands.md) document.

So, that's it! Now, you can actually start creating your own map. Mostly, you need to add buildings, roads, and other objects to make it look like a real map. And the painted textures will help you to place them correctly, just like in the real world.
Expand Down
7 changes: 7 additions & 0 deletions webui/videos.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,12 @@
"description": "How to edit data on the public version of OpenStreetMap and how to use custom OSM files.",
"link": "https://www.youtube.com/watch?v=duTXvkIiECY",
"image": "https://github.com/user-attachments/assets/6d0d0f8b-ff68-4d2e-8e3f-924e1c6afeb8"
},
{
"episode": 2,
"title": "How to launch the tool locally?",
"description": "How to install Docker and launch the tool locally.",
"link": "https://youtu.be/1AHGIxTxSBM",
"image": "https://github.com/user-attachments/assets/ed798b45-61b6-4080-b669-fea87d663413"
}
]

0 comments on commit eb5f3e5

Please sign in to comment.