Create a User Guide for SOTI

[Koloss0]

🗒️ Task Description

Summary
Create a guide that teaches people how to set up and use SOTI!

Details
Currently we don't have much documentation explaining how to actually use the application. That means most of that information just exists in the heads of the Software team (basically just me and Arnav). That's a bit of an issue because if we leave the team that information could get lost forever! (or until someone figures it out)

Your role in this task is to make the process of learning how to use this program really easy. This will involve a lot of writing, inspecting code, experimentation, and performing interviews with me and Arnav.

In the main README of the project, you should update anything that's out of date, and focus more on providing information for someone who's going to want to actually USE the application. This might include a summary of what it does, installation instructions, an overview of the hardware you need, and a list of commands the user can enter into the command prompt.

If all this ends up being a long task, we might be able to break it down into smaller tasks and get multiple people to work on it.

✅ Completion Criteria

• For the top-level README.md:
  • Overview is up-to-date.
  • the Requirements section is removed (we shouldn't talk about design requirements here).
  • There's a section explaining what the heck SOTI even is!
  • There's a section explaining the purpose of SOTI and how it achieves that purpose.
  • An Installation section is added with sub-sections Prerequisites and Steps.
  • A quick section Updating the PCB Firmware is added with instructions on how to update the firmware on the SOTI board (Hint: You just need to plug in a USB-C cable and run the code in STM32CubeIDE!).
  • A brief overview of the commands found inside the front-end (Python) application.
• Remove soti/README.md (the CLI user guide). All that information should be presented in the top-level README.md.

📂 Affected Components

• Only README.md will be modified.
• soti/README.md will be deleted.

🚧 Notes / Reference

• Read the existing README files to get a rough idea. Then talk with me and Arnav to get more content for your guide.
• For an example of a well-written guide, take a look at the TSAT Utilities Kit Wiki.