Skip to content

Commit 082a2d2

Browse files
authored
Merge pull request #66 from FilipRuman/Restructured-README.md
Restructured README.md
2 parents 25201f2 + 16fbf8f commit 082a2d2

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,34 @@
1313
![image](https://github.com/user-attachments/assets/90f16e62-3171-4c9d-a4b6-db6b02824efc)
1414
# [Example video of training](https://www.youtube.com/watch?v=t2lAXXAaJoI)
1515
![image](https://github.com/user-attachments/assets/66e4e7fc-4608-4d3a-8874-8fbb7ee20ccc)
16+
### this project aims to provide good user experience with clear ui, easy to use tools and great documentation alongside **SAFETY first design** .
17+
# 🔭 Overview
18+
4Form allows users to create interesting training in the exact way they like by allowing community to create:
19+
* maps
20+
* routes
21+
* equipment
22+
* game modes
23+
* competitions
24+
25+
26+
# **Base** Of this project will be free and open source **forever**.
27+
28+
# ✅Features
29+
### Implemented
30+
* **easy to use tools for routes creation** - create routes using path3D and custom tool makes it smoothly follow terrain.
31+
* **integration with [terrain3D](https://github.com/TokisanGames/Terrain3D)** - allows easy creation of great looking maps.
32+
* **multi-platform** - windows 11 && 10, mac, and *****linux***(most distros if you do some tinkering)
33+
34+
### Future plans
35+
- [ ] steam release
36+
- [ ] multiplayer with steam and steam workshop to download maps
37+
- [ ] safe custom scripts in users content
1638
> [!Caution]
1739
> **This project is in really early stage of development**
1840
> It will change a lot in the future and **MOST** of the intended features are not *yet* implemented.
1941
>
2042
> it's not production ready. But I need contributes for further development.
43+
2144
## ⭐ If you think this project sounds interesting and you might use it in the future when it's production ready. Then please give this repo a star, it helps a lot.
2245
# 🛠️ Installation
2346
## If you want to test it out, just download [the latest release](https://github.com/FilipRuman/4Form/releases) for your platform
@@ -45,28 +68,6 @@ Turn on the advance settings.
4568
* Main Font Bold: assets/Meslo/MesloLGLDZNerdFont-Bold.ttf
4669
* Code Font: assets/Meslo/MesloLGLDZNerdFont-Regular.ttf
4770
### You are ready to run it!
48-
# 🔭 Overview
49-
4Form allows users to create interesting training in the exact way they like by allowing community to create:
50-
* maps
51-
* routes
52-
* equipment
53-
* game modes
54-
* competitions
55-
56-
### this project aims to provide good user experience with clear ui, easy to use tools and great documentation alongside **SAFETY first design** .
57-
58-
# **Base** Of this project will be free and open source **forever**.
59-
60-
# ✅Features
61-
### Implemented
62-
* **easy to use tools for routes creation** - create routes using path3D and custom tool makes it smoothly follow terrain.
63-
* **integration with [terrain3D](https://github.com/TokisanGames/Terrain3D)** - allows easy creation of great looking maps.
64-
* **multi-platform** - windows 11 && 10, mac, and *****linux***(most distros if you do some tinkering)
65-
66-
### Future plans
67-
- [ ] steam release
68-
- [ ] multiplayer with steam and steam workshop to download maps
69-
- [ ] safe custom scripts in users content
7071

7172
### [For progress tracking use development project](https://github.com/users/FilipRuman/projects/6/views/3)
7273
# Contact email: 4formproject@gmail.com

0 commit comments

Comments
 (0)