updated rleease notes

README.md

@@ -1,53 +1,43 @@
 # Spearhead
 
+Hello and welcome to Spearhead!
 
-## Contributing. 
+If you're a developer that wants to contribute, look at the code or understand what we're doing, feel free to read on.
 
-I'm always happy to see contributions! <br/>
-Especially if you've found an issue, annoyance or feature that you know how to solve, fix or create! <br/>
+If you're a mission maker that wants to see the documentation and build you mission with this framework. <br>
+It's best to go to our fully fledged documentation website: 
+- Stable/Main:  https://spearhead.rocks
+- Beta/Develop: https://beta.spearhead.rocks
 
-### Keep it small. 
+## Project Structure
 
-Keeping your contributions small and to the point helps both me and yourself. <br/>
-It'll help the PR review and the speed of improvements. <br/>
-If you have a big feature in mind? Go for it! <br/>
-Does it require an entire refactor of parts or all of the program? Maybe make sure to do step 0 first.
+The Spearhead project is structured in a lot of separate files. <br>
+While Lua isn't specifically created for it, most of it has been written with the standards of OOP in mind. <br>
+Classes, Objects and helper methods. 
 
-### Steps (for first timers)
-0. Reach out (Optional)
+You're find in the `/src` folder all the files. <br>
+They are separated in a somewhat logical order, but some things might feel out of place. <br>
 
-If you want to let me know you want to do something to contribute, please do! <br/>
-Maybe I'm already working on the thing you wanted to build, or someone else is. <br/>
-Creating an issue is even better! <br/>
+### Bundling, Intellisense, Linting
 
+In DCS the easiest way to import a script is with 1 single file, however, that's not as "maintainable".
+In order to keep it maintainable we're using a self-built tool to bundle, validate and rewrite some of the lua in order to get it into a single file.
+The tool is open-source here: https://git.dutchie031.com/dutchie031/DcsMissionScriptingTools. <br>
+It has a `VSCode` extensions and two `Github Action` steps. <br>
+If your favorite IDE isn't `VSCode` (I respect that), it might be very easy to create an extension for it, if it does allow that. 
 
-1. Fork the repository
+The `VSCode` extensions comes with Intellisense as well, in the form of a full file of DCS lua type annotations. <br>
+This gives the Lua Language Server by Sumneko (which can be used in `VSCode`) all the type definitions it needs. 
+When writing Spearhead code it is also important to keep our own LuaLS Annotations up to date and complete. <br>
+Read all about those annotations here: https://luals.github.io/wiki/annotations/
 
-By forking you can create your own working set of code. <br/>
-Whether you keep that fork public or private is up to you! <br/>
+When a pull-request to the `develop` or `main` branches is created, before it can be merged it requires to pass the linter checks. 
+The first linting check is done by the Lua Language Server. It checks for whitespace and formatting, but it also checks if all types, type-checking and casts are in order. It marks unused variables etc. `.luarc.json` has all the config for those checks. <br>
+The second linter job is with `luacheck` which first "bundles" the script, and then runs a full linter check over the bundled script. <br>
+This is to make sure that also the bundled script does not contain any errors.
 
-Keep in mind, forking is alright, but it's best with the intent to contribute back. <br/>
-After all, instead of having 5 slightly different versions and products, it might be nicer to have 1 much better version. <br/>
+## Contributing
 
-2. Create a Draft PR as soon as possible!
+### Setting up the project
 
-As soon as you've found some times to create an initial version, please create a draft PR. <br/>
-That way you can let me and everyone know it's being worked on and people can see what conflicts might arise with their own changes. <br/>
-
-3. Test, test, test
-
-With DCS and Lua there's a bunch of edge cases that are really hard to get to. <br/>
-However, you kinda need to make sure most if not all cases are caught and tested. <br/>
-Since automated testing for now doesn't seem feasible, please make sure to verify and test functionality after touching stuff. <br/>
-
-4. Finalise and publish the PR. 
-
-Finalise the PR and let the maintainers know! <br/>
-We can all have a look and discuss the changes. <br/>
-
-
-
-
-# TODO: 
-
-- Would it be possible to generate optional markers on mission briefing locations for Tomcat / Phantom navigation? Then Jester can type it in for the pilots automatically.
+If you've kept on reading I assume you either want to brwose