From 5896f81d0c2a65b51a6cf0ed6794f12c2f08e53f Mon Sep 17 00:00:00 2001 From: Stan Soldatov <118521851+iwatkot@users.noreply.github.com> Date: Sat, 8 Feb 2025 22:26:52 +0100 Subject: [PATCH] Docs updates * Docs updates. * Docs updates. --- README.md | 2 ++ docs/FAQ.md | 4 ++++ docs/README.md | 2 ++ docs/custom_osm.md | 4 ++++ webui/generator/generator.py | 5 +++++ webui/templates.py | 21 ++++++++++++++++++++- 6 files changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe1a0611..b4e555c6 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@
🌽 Automatic farmlands generation based on the fields.

+📹 WIP: Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕
+ 📹 A complete step-by-step video tutorial is here! diff --git a/docs/FAQ.md b/docs/FAQ.md index c4b97159..422ff4e7 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,5 +1,9 @@ ## Frequently Asked Questions +📹 Learn where the map data come from in this video. + + + In this section, you will find anwers to the most frequently asked questions about the project. Please, before asking a question, or opening an issue, check if the answer is already here. Thank you! ### Some objects are not appear on the map, why? diff --git a/docs/README.md b/docs/README.md index e4fbd699..a700660f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,7 @@ ## How to use maps4fs? +📹 WIP: Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕
+ Hey, welcome to the maps4fs documentation! Here you will find all the information you need to use maps4fs. Recommended reading order: diff --git a/docs/custom_osm.md b/docs/custom_osm.md index ca6a793f..a4e41031 100644 --- a/docs/custom_osm.md +++ b/docs/custom_osm.md @@ -1,5 +1,9 @@ ## How to create a custom OSM file +📹 Check out the video version of this tutorial. + + + If you don't want to bother yourself editing the public version of the OSM data, deal with the community and so on, you can easily create your own OSM file and do there whatever you want. Here is a step-by-step guide on how to do it. 1. Download the JOSM editor from the [official website](https://josm.openstreetmap.de/) or directly from the [Windows Store](https://apps.microsoft.com/detail/xpfcg1gv0wwgzx) with one click. diff --git a/webui/generator/generator.py b/webui/generator/generator.py index c052217d..a07005c2 100644 --- a/webui/generator/generator.py +++ b/webui/generator/generator.py @@ -55,6 +55,11 @@ def __init__(self): with self.left_column: if config.is_on_community_server(): st.error(Messages.MOVED, icon="🚜") + + if config.is_on_community_server() or self.public: + with st.expander("🚨 READ THIS! SCAM ALERT! 🚨", expanded=True): + st.error(Messages.PUBLIC_WARNING) + self.add_left_widgets() self.main_settings.map_preview() diff --git a/webui/templates.py b/webui/templates.py index 88ed7062..6da807fc 100644 --- a/webui/templates.py +++ b/webui/templates.py @@ -8,8 +8,27 @@ class Messages: "maps, or just chat. \n" "🤗 If you like the project, consider supporting it on [Buy Me a Coffee](https://www.buymeacoffee.com/iwatkot) or " "[Patreon](https://www.patreon.com/iwatkot). \n" - "📹 A complete step-by-step video tutorial is on [YouTube](https://www.youtube.com/watch?v=Nl_aqXJ5nAk&)!" + "📹 A complete step-by-step video tutorial is on [YouTube](https://www.youtube.com/watch?v=Nl_aqXJ5nAk&)! \n" + "📹 WIP: Check out the complete playlist of video turorials on [YouTube]" + "(https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕" ) + + PUBLIC_WARNING = ( + "maps4fs is a completely free and open source tool, which DOES NOT REQUIRE DOWNLOADING " + "ANYTHING. \n" + "If someone asks you to PAY FOR ANYTHING, OR DOWNLOAD ANY FILE, IT'S A SCAM! \n" + "🚨 DO NOT DOWNLOAD ANY FILES FROM ANY WEBSITES, DO NOT PAY ANYONE FOR THE SOFTWARE! \n" + "IF YOU SEE A WEBSITE, WHICH OFFERS TO DOWNLOAD THE APP, IT'S A SCAM! \n" + "THE ONLY TRUSTED SOURCE OF THE INFORMATION IS THE [OFFICIAL REPOSITORY]" + "(https://github.com/iwatkot/maps4fs). \n" + "🚨 THE ONLY TRUSTED PUBLIC VERSION OF THE APP IS ON THIS WEBSITE: https://maps4fs.xyz. \n" + "🚨 DO NOT USE ANY OTHER WEBSITE WHICH OFFER YOU THE TOOL, IT'S A SCAM! \n" + "🚨 THE LOCAL VERSION DOES NOT REQUIRE TO DOWNLOAD ANYTHING, YOU ONLY NEED TO EXECUTE" + "THE DOCKER COMMAND! \n" + "If you find any website, that offers you the tool outside of the trusted links " + "please report it in the [Discord server](https://discord.gg/Sj5QKKyE42)." + ) + MOVED = "The app has moved to ➡️➡️➡️ [maps4fs.xyz](https://maps4fs.xyz)" MAIN_PAGE_COMMUNITY_WARNING = ( "🚜 Hey, farmer! \n"