Mirror/Momentum-Firmware
1
0
Fork 0
mirror of https://github.com/Next-Flip/Momentum-Firmware.git synced 2026-05-10 05:59:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Xero initial commit

Browse Source
This commit is contained in:
noproto
2024-10-01 23:49:12 -04:00
parent 913a86bbec
commit 3563bccdf8
2 changed files with 90 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
ReadMe.md
View File

@@ -1,45 +1,47 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="/.github/assets/dark_theme_banner.png">
<source media="(prefers-color-scheme: light)" srcset="/.github/assets/light_theme_banner.png">
<img
alt="A pixel art of a Dophin with text: Flipper Zero Official Repo"
src="/.github/assets/light_theme_banner.png">
</picture>
<p align="center">
<img src=".github/assets/xero.svg">
</p>
# Flipper Zero Firmware
Xero is a fork of the [official Flipper Zero firmware](https://github.com/flipperdevices/flipperzero-firmware) that focuses on providing the latest NFC/RFID features, improved memory utilization, a curated selection of applications, and above all: stability.
Flipper Zero resources:
- [Flipper Zero Official Website](https://flipperzero.one). A simple way to explain to your friends what Flipper Zero can do.
- [Flipper Zero Firmware Update](https://update.flipperzero.one). Improvements for your dolphin: latest firmware releases, upgrade tools for PC and mobile devices.
- [User Documentation](https://docs.flipperzero.one). Learn more about your dolphin: specs, usage guides, and anything you want to ask.
- [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen). Dive into the Flipper Zero Firmware source code: build system, firmware structure, and more.
- [Official Documentation](https://docs.flipperzero.one). Learn more about your dolphin: specs, usage guides, and anything you want to ask.
- [Community Wiki](https://flipper.wiki/). Contribute to the community wiki covering what is possible on the Flipper Zero.
# Why Xero
Coming from the **Official Firmware** (OFW), you'll get:
* Newly supported cards and protocols
* Fixes and performance improvements for existing cards and protocols
* Reduced memory usage of core applications
* A curated list of community applications with a focus on utility
Coming from other custom firmware, you'll get:
* All of the above
* General stability improvements
* Reduced memory usage
* Minimal theming
# Xero features
* Ultralight C attacks (coming soon!)
* Minimal theme (coming soon!)
# Contributing
Our main goal is to build a healthy and sustainable community around Flipper, so we're open to any new ideas and contributions. We also have some rules and taboos here, so please read this page and our [Code of Conduct](/CODE_OF_CONDUCT.md) carefully.
## I need help
The best place to search for answers is our [User Documentation](https://docs.flipperzero.one). If you can't find the answer there, check our [Discord Server](https://flipp.dev/discord) or our [Forum](https://forum.flipperzero.one/). If you want to contribute to the firmware development, or modify it for your own needs, you can also check our [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen).
## I want to report an issue
If you've found an issue and want to report it, please check our [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.
## I want to contribute code
Before opening a PR, please confirm that your changes must be contained in the firmware. Many ideas can easily be implemented as external applications and published in the [Flipper Application Catalog](https://github.com/flipperdevices/flipper-application-catalog). If you are unsure, reach out to us on the [Discord Server](https://flipp.dev/discord) or the [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page, and we'll help you find the right place for your code.
Also, please read our [Contribution Guide](/CONTRIBUTING.md) and our [Coding Style](/CODING_STYLE.md), and make sure your code is compatible with our [Project License](/LICENSE).
Finally, open a [Pull Request](https://github.com/flipperdevices/flipperzero-firmware/pulls) and make sure that CI/CD statuses are all green.
# Development
Flipper Zero Firmware is written in C, with some bits and pieces written in C++ and armv7m assembly languages. An intermediate level of C knowledge is recommended for comfortable programming. C, C++, and armv7m assembly languages are supported for Flipper applications.
If you've found an issue and want to report it, please check our [Issues](https://github.com/noproto/xero-firmware/issues) page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.
# Firmware RoadMap
[Firmware RoadMap Miro Board](https://miro.com/app/board/uXjVO_3D6xU=/)
[Firmware RoadMap](https://github.com/noproto/xero-firmware/projects?query=is%3Aopen)
## Requirements
@@ -63,7 +65,7 @@ Flipper Build System will take care of all the other dependencies.
Make sure you have enough space and clone the source code:
```shell
git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
git clone --recursive https://github.com/noproto/xero-firmware.git
```
## Building
@@ -87,36 +89,9 @@ Connect your in-circuit debugger to your Flipper and flash firmware using Flippe
Make sure your Flipper is on, and your firmware is functioning. Connect your Flipper with a USB cable and flash firmware using Flipper Build Tool:
```shell
./fbt flash_usb
./fbt flash_usb_full
```
## Documentation
- [Flipper Build Tool](/documentation/fbt.md) - building, flashing, and debugging Flipper software
- [Applications](/documentation/AppsOnSDCard.md), [Application Manifest](/documentation/AppManifests.md) - developing, building, deploying, and debugging Flipper applications
- [Hardware combos and Un-bricking](/documentation/KeyCombo.md) - recovering your Flipper from the most nasty situations
- [Flipper File Formats](/documentation/file_formats) - everything about how Flipper stores your data and how you can work with it
- [Universal Remotes](/documentation/UniversalRemotes.md) - contributing your infrared remote to the universal remote database
- [Firmware Roadmap](https://miro.com/app/board/uXjVO_3D6xU=/)
- And much more in the [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen)
# Project structure
- `applications` - Applications and services used in firmware
- `applications_users` - Place for your additional applications and services
- `assets` - Assets used by applications and services
- `documentation` - Documentation generation system configs and input files
- `furi` - Furi Core: OS-level primitives and helpers
- `lib` - Our and 3rd party libraries, drivers, tools and etc...
- `site_scons` - Build system configuration and modules
- `scripts` - Supplementary scripts and various python libraries
- `targets` - Firmware targets: platform specific code
Also, see `ReadMe.md` files inside those directories for further details.
# Links
- Discord: [flipp.dev/discord](https://flipp.dev/discord)
- Website: [flipperzero.one](https://flipperzero.one)
- Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)
- Kickstarter: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
- Official Discord: [flipp.dev/discord](https://flipp.dev/discord)