Document the whole thing

adiee5 · May 12, 2024 · 90c2f82 · 90c2f82
1 parent 1043393
commit 90c2f82
Show file tree

Hide file tree

Showing 11 changed files with 715 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# F1 Robota Pro
+*F1 Robota Pro* is a F1 race simulator I've made back in 2022 for the use in F1 roleplay discord servers we used to make with my friend back in a day. You can configure the stats of Drivers, Teams, weather, etc. Keep in mind, that the whole thing is in Polish language, there is no english translation of the program.
+
+![Main menu of the program](/docs/rsc/main-view.png)
+
+As of writing this, I'm currently in the process of learning Rust and I plan to port this program to Rust once I get a hang of it. 
+
+## Building
+Just clone the repo, open it in Visual Studio 2019 or newer and compile it using that. Other methods have not been tested.
+
+## Documentation
+See *[docs](/docs/)* to get more info about this program. 
+
+## License
+Since the public release in May 2024, this code is licensed under **GPLv3**. It's also recommended that you provide a link to this project (`https://github.com/adiee5/f1-robota-pro`) in the service (e.g. Discord server) in which you use this project. Feel free to fork and modify the program!
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+1. [**Usage**](usage.md) (finished)
+2. **History** (coming soon)
+3. **Program Internal Structure** (coming soon)
diff --git a/docs/rsc/RacerView.png b/docs/rsc/RacerView.png
diff --git a/docs/rsc/TeamView-options.png b/docs/rsc/TeamView-options.png
diff --git a/docs/rsc/TeamView.png b/docs/rsc/TeamView.png
diff --git a/docs/rsc/main-desc.png b/docs/rsc/main-desc.png
diff --git a/docs/rsc/main-view-options.png b/docs/rsc/main-view-options.png
diff --git a/docs/rsc/main-view.png b/docs/rsc/main-view.png
diff --git a/docs/rsc/newly-booted.png b/docs/rsc/newly-booted.png
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1,23 @@
+# Usage
+In order to use the program, It's recommended to know the Polish language, as the entire user interface is written in Polish. For those, that don't know it, I'll try to explain stuff anyways.
+
+Upon executing the program, you'll see this view:
+![An instance of a newly booted program](rsc/newly-booted.png)
+
+This is the main menu of the program, let's examine it a little bit:
+![main wiev with descriptions](rsc/main-desc.png)
+1. *Team Settings*
+2. *Racer Settings*
+3. *RACE!!!*
+4. This is the place where the final results of the race will be displayed
+5. *Turn off the DNF* - When checked, DNFs (Events, that cause specific racers not to finish the race) will not happen
+6. *Rain*
+7. The place to describe how many loops do you want in the race
+8. After the race is finished, you can press this button to export the results in form of a CSV file (values are separated with `;` and the CSV is not UTF-8 encoded, because excel asked me to)
+9. *Options* - There isn't anything that important in here, we'll come back here later.
+
+Firstly, we need to define our Teams, let's click the `Teams Settings` button, if you didn't set up the Teams before (you probably didn't at this point) a prompt for a new team name will show up. Just write sth and you'll have a team config menu:
+![The window, where you configure Teams](rsc/TeamView.png)
+1. *Team* - you use this combobox to select what team do you want to modify
+2. *Achievements* - A time value provided in Seconds (accepts fractions). What are you supposed to type there? How to come up with the value? I don't know, I wasn't the one who organised F1 roleplays nor the one who used this program, I only designed it. I guess type here something that you find apropriate. This is the case with most values you need to provide - just come up with something!
+3. *Endurance*