Skip to content

Commit

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

* Docs updates.
  • Loading branch information
iwatkot authored Feb 8, 2025
1 parent 3786216 commit 5896f81
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@
<img width="480" src="https://github.com/user-attachments/assets/4d1fa879-5d60-438b-a84e-16883bcef0ec"><br>
🌽 Automatic farmlands generation based on the fields.<br><br>

📹 WIP: Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕<br>

📹 A complete step-by-step video tutorial is here!
<a href="https://www.youtube.com/watch?v=Nl_aqXJ5nAk" target="_blank"><img src="https://github.com/user-attachments/assets/4845e030-0e73-47ab-a5a3-430308913060"/></a>

Expand Down
4 changes: 4 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Frequently Asked Questions

📹 Learn where the map data come from in this video.

<a href="https://www.youtube.com/watch?v=hPbJZ0HoiDE" target="_blank"><img src="https://github.com/user-attachments/assets/4e3e1e1a-7882-4673-87c4-f913775d178e"/></a>

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?
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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). 🆕<br>

Hey, welcome to the maps4fs documentation! Here you will find all the information you need to use maps4fs.
Recommended reading order:

Expand Down
4 changes: 4 additions & 0 deletions docs/custom_osm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## How to create a custom OSM file

📹 Check out the video version of this tutorial.

<a href="https://www.youtube.com/watch?v=duTXvkIiECY" target="_blank"><img src="https://github.com/user-attachments/assets/8e130247-57f2-4d0a-9a9a-a13fa847c0d8"/></a>

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.
Expand Down
5 changes: 5 additions & 0 deletions webui/generator/generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
21 changes: 20 additions & 1 deletion webui/templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 5896f81

Please sign in to comment.