diff --git a/README.md b/README.md index d5b336dc64866ecad586969f6c0aa56135cded57..d672fbb335c16de0704abbedbe5ba16eed5eb9e3 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,11 @@ -# R2A-HERMES OBSW [](https://git.skywarder.eu/r2a/skyward-boardcore/commits/master) +*Software for X-Wing Test Board* -*Software for R2A-Hermes* - -This repository contains the On-Board Software for R2A-Hermes. +This repository contains the On-Board Software for the X-Wing board, used for testing the "Rogallina" wing. To clone, use the `--recurse-submodules` option. To build, use `sbs` (for more info, type `./sbs --help` on Linux or `sbs --help` on Windows). - - -## Folder Structure - -| **src/** | **sources!** | -| ---------------------- | --------------------------------------------------- | -| boards/ | Classes source files, divided per board. | -| entrypoints/ | Each file here is a "*main*" to be built with SBS. | -| tests/ | Tests that can be built with SBS. | -| **skyward-boardcore/** | Provides the build system (SBS) and common drivers. | -| **bin/** | Compiled binaries, to be flashed on boards. | -| **build/** | MIOSIX Makefiles generated by SBS (*not important*) | -| **obj/** | Building stuff (*not important*) | - -## Content - -This repo contains software components that are specific to R2A-Mini a.k.a Hermes. - ## Contributing If you are developing new features, branch off from the `testing` branch and then merge back. \ No newline at end of file