diff --git a/README.md b/README.md index 245a36c7..9478af0b 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,6 @@ ![](https://github.com/Flipper-Zero/wiki/blob/master/images/firmware-wiki-header.gif) This repo contains [Flipper Zero](https://flipperzero.one/zero)'s Firmware core, cleaned from all dirty demos, and prepared for contributors. Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date. -# Project structure -``` -├── app # App -├── target_f1 # target f1 -├── target_lo # ?? -├── wiki # Documentation generates from this files -└── wiki-deploy.sh # Script to generate Wiki from local .md files -``` # Building @@ -25,6 +17,15 @@ To contribute to code or to wiki make the following steps: 3. Ensure you read and sign [Flipper CLA](https://cla-assistant.io/glitchcore/flipper-cla-host) 4. Read Flipper [Roadmap](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Flipper-roadmap) +# Project structure +``` +├── app # App +├── target_f1 # target f1 +├── target_lo # local target (for linux) +├── wiki # Documentation (wiki) generates from this files +└── wiki-deploy.sh # Script to generate Wiki from local .md files +``` + # UI Common UI feature (menu, screens, features) at [UI page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/UI)