-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Description
The readme is pretty outdated. It would be a solid idea to rewrite this to have pictures of the new UI, show off its capabilities (video sync, multiple graphs, presets, map, model, whichever look the coolest), then ensure the installation instructions are up to date (maybe recommend latest release, then dev install).
Finally, I would recommend moving specific instructions into their respective folders, meaning for example, the E2E instructions could be placed directly inside the E2E folders readme. Then, in the main readme, just describe the folder layout / project structure so people know to look there for instructions. Could even do something like this
Just referencing them in some way, debloat the actual one.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation