raspiblitz/README.md
2024-03-29 17:52:13 +01:00

38 lines
No EOL
1.8 KiB
Markdown

# ![RaspiBlitz](pictures/raspilogo_tile_400px.png)
_Build your own Bitcoin & Lightning Fullnode on a RaspberryPi with an optional Display._
![RaspiBlitz](pictures/raspiblitz.jpg)
**The RaspiBlitz is a do-it-yourself Bitcoin & Lightning Fullnode running on a RaspberryPi with a nice display for easy setup & monitoring.**
RaspiBlitz is mainly targeted for learning how to run your own node decentralized from home - because: Not your Node, Not your Rules. Discover & develop the open-source ecosystem of Bitcoin by becoming a full part of it.
**Links to Quickstart your RaspiBlitz journey:**
- [Project Homepage: raspiblitz.org](https://raspiblitz.org)
- [How to build & setup your own RaspiBlitz & Documentation](https://docs.raspiblitz.org/docs/intro)
- [Download latest SD Card images](https://docs.raspiblitz.org/docs/setup/software-setup/download)
- [How to get Support](https://docs.raspiblitz.org/docs/community/support)
**Additional Resources:**
- [ChangeLog](CHANGES)
- [FAQ User](https://docs.raspiblitz.org/docs/faq)
- [FAQ Development](https://docs.raspiblitz.org/docs/faq/dev)
- [FAQ Core Lightning](https://docs.raspiblitz.org/docs/faq/cl)
- [Workshop Tutorial](https://docs.raspiblitz.org/docs/faq/cl)
- [Security Policy](https://docs.raspiblitz.org/docs/security)
- [Alternative Platforms](alternative.platforms/README)
- [Automated Builds](ci/README)
- [MIT OpenSource License](LICENSE)
**Developer Notes:**
This is main RaspiBlitz repo containing the **bash & python** scripts to build the RaspiBlitz software. It it complimented by the following side repos:
- [WebUI](github.com/raspiblitz/raspiblitz-web) (React & Tailwind)
- [API](github.com/fusion44/blitz_api) (Python FastAPI)
- [Documentation](github.com/raspiblitz/raspiblitz-docs) (Docusaurus)
To get started with RaspiBlitz Development check the [Community Development](CONTRIBUTING) notes.