feather/README.md

69 lines
3.4 KiB
Markdown
Raw Normal View History

2021-10-28 23:10:01 +00:00
# Feather Wallet
2024-10-03 13:22:00 +00:00
Feather is a free Monero desktop wallet for Linux, Tails, macOS and Windows. It is written in C++ with the Qt framework.
2024-10-03 13:22:00 +00:00
- **easy-to-use**, **small** and **fast** - Feather runs well on any modern hardware, including virtual machines and live operating systems.
- **beginner friendly**, but also caters to advanced Monero users by providing a [feature set](https://docs.featherwallet.org/guides/features) that is on par with the official CLI.
- ships with **sane defaults** that suit most users, but can also be configured for high or uncommon threat models.
- serves as a testing grounds for **experimental features** that may later be adopted in the reference wallets.
2024-10-03 13:22:00 +00:00
## Download
2021-10-28 23:10:01 +00:00
2024-10-03 13:22:00 +00:00
You can download Feather from **[featherwallet.org](https://featherwallet.org/download/)** or **[GitHub](https://github.com/feather-wallet/feather/releases)**.
2021-10-28 23:10:01 +00:00
2024-10-23 23:20:59 +00:00
If you need help installing Feather, check the [installation documentation](https://docs.featherwallet.org/).
2024-11-04 12:58:55 +00:00
We recommend that you verify downloads with GPG. Releases are signed with our [release signing key](https://docs.featherwallet.org/guides/release-signing-key). The fingerprint is:
2024-10-03 16:08:44 +00:00
```
8185 E158 A333 30C7 FD61 BC0D 1F76 E155 CEFB A71C
```
2024-11-04 12:58:55 +00:00
Windows releases are code-signed for free by [SignPath.io](https://about.signpath.io/), certificate by [SignPath Foundation](https://signpath.org/).
2024-10-03 13:22:00 +00:00
## Resources
2024-10-03 13:22:00 +00:00
* [Official Site](https://featherwallet.org)
* [Documentation](https://docs.featherwallet.org)
* [Git Repository](https://github.com/feather-wallet/feather)
* [Matrix](https://matrix.to/#/#feather:monero.social)
* IRC: `#feather` on [OFTC](https://www.oftc.net/)
* Mail: dev@featherwallet.org
2022-05-26 16:58:54 +00:00
2024-10-03 13:22:00 +00:00
If you need help with your wallet, please contact us via Matrix or IRC.
If you don't have an IRC client, you can join the room via [webchat](https://webchat.oftc.net/?randomnick=1&channels=feather).
If you dont receive a response immediately please idle in the room.
## Release Builds
2024-10-03 13:22:00 +00:00
To learn how to run a bootstrappable release build, see: [contrib/guix/README.md](https://github.com/feather-wallet/feather/blob/master/contrib/guix/README.md)
2022-05-26 16:58:54 +00:00
2024-10-03 16:08:44 +00:00
For release attestations, see the [feather-sigs](http://github.com/feather-wallet/feather-sigs) repo.
2024-10-03 13:22:00 +00:00
2024-10-03 16:08:44 +00:00
For release policy, see: [RELEASE.md](https://github.com/feather-wallet/feather/blob/master/RELEASE.md)
2022-05-26 16:58:54 +00:00
2022-06-02 12:50:33 +00:00
## Development
2022-05-26 16:58:54 +00:00
If you are looking to set up a development environment for Feather, see [HACKING.md](https://github.com/feather-wallet/feather/blob/master/HACKING.md).
2024-10-03 13:22:00 +00:00
It is highly recommended that you join our Matrix or IRC channel if you are hacking on Feather.
Idling in this channel is the best way to stay updated on best practices and new developments.
2024-10-03 16:08:44 +00:00
For information on how Feather is maintained, see: [MAINTENANCE.md](https://github.com/feather-wallet/feather/blob/master/MAINTENANCE.md)
2024-10-03 13:22:00 +00:00
2024-10-03 16:16:40 +00:00
To report a security vulnerability, see: [SECURITY.md](https://github.com/feather-wallet/feather/blob/master/SECURITY.md)
2024-10-03 13:22:00 +00:00
## Support
Feather is funded entirely through donations. We don't take a cut from transaction fees and make no money from exchange integrations.
Donations help pay for hosting, build servers, domain names, e-mail and other recurring costs. Any amount helps.
`47ntfT2Z5384zku39pTM6hGcnLnvpRYW2Azm87GiAAH2bcTidtq278TL6HmwyL8yjMeERqGEBs3cqC8vvHPJd1cWQrGC65f`
## License
Feather is free and open-source software, [licensed under BSD-3](https://raw.githubusercontent.com/feather-wallet/feather/master/LICENSE).
Copyright (c) 2020-2024, The Monero Project