From eb5f3e51e86138436341ea08f2eecd229b603e8f Mon Sep 17 00:00:00 2001 From: Stan Soldatov <118521851+iwatkot@users.noreply.github.com> Date: Sun, 16 Feb 2025 20:56:03 +0100 Subject: [PATCH] Docs update * Docs update. * Docs update. --- README.md | 3 +++ docs/FAQ_docker.md | 5 +++++ docs/step_by_step.md | 2 +- webui/videos.json | 7 +++++++ 4 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bbb5794..c3aefc6 100644 --- a/README.md +++ b/README.md @@ -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.
+ +📹 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. diff --git a/docs/FAQ_docker.md b/docs/FAQ_docker.md index 87f302e..3848c63 100644 --- a/docs/FAQ_docker.md +++ b/docs/FAQ_docker.md @@ -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! diff --git a/docs/step_by_step.md b/docs/step_by_step.md index be33b49..1f775e6 100644 --- a/docs/step_by_step.md +++ b/docs/step_by_step.md @@ -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. diff --git a/webui/videos.json b/webui/videos.json index da0cfeb..c5c8953 100644 --- a/webui/videos.json +++ b/webui/videos.json @@ -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" } ]