mirror of
https://github.com/feather-wallet/feather.git
synced 2024-11-16 17:27:38 +00:00
More docs updates
This commit is contained in:
parent
10355ada2b
commit
6d47b58bf7
3 changed files with 29 additions and 51 deletions
51
BUILDING.md
51
BUILDING.md
|
@ -1,4 +1,9 @@
|
||||||
## Building with Docker
|
# Building Feather
|
||||||
|
|
||||||
|
Release binaries (except macOS) are built using Docker. If you are looking to build Feather without Docker,
|
||||||
|
see [HACKING.MD](https://github.com/feather-wallet/feather/blob/master/HACKING.md).
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
Builds with Docker are done in 3 steps:
|
Builds with Docker are done in 3 steps:
|
||||||
|
|
||||||
|
@ -144,46 +149,6 @@ If you're re-running a build make sure to `rm -rf build/` first.
|
||||||
|
|
||||||
The resulting binary can be found in `./build/x86_64-w64-mingw32/release/bin/`.
|
The resulting binary can be found in `./build/x86_64-w64-mingw32/release/bin/`.
|
||||||
|
|
||||||
---
|
### macOS
|
||||||
|
|
||||||
## Building on macOS
|
Docker builds for macOS are not currently supported. To build Feather on macOS follow the steps in [HACKING.md](HACKING.md).
|
||||||
|
|
||||||
For macOS it's easiest to leverage [brew](https://brew.sh) to install the required dependencies.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install qt libsodium libzip qrencode unbound cmake boost hidapi openssl expat libunwind-headers protobuf pkgconfig zbar
|
|
||||||
```
|
|
||||||
|
|
||||||
Build and install Polyseed:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/tevador/polyseed.git
|
|
||||||
cd polyseed
|
|
||||||
mkdir build
|
|
||||||
cd build
|
|
||||||
cmake ..
|
|
||||||
make
|
|
||||||
sudo make install
|
|
||||||
```
|
|
||||||
|
|
||||||
Clone the Feather repository.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone --recursive https://github.com/feather-wallet/feather.git
|
|
||||||
cd feather
|
|
||||||
```
|
|
||||||
|
|
||||||
Build Feather.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make mac-release
|
|
||||||
```
|
|
||||||
|
|
||||||
The resulting macOS application can be found `build/bin/feather.app` and will **not** have Tor embedded.
|
|
||||||
|
|
||||||
To run a Tor daemon on macOS:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install tor
|
|
||||||
brew services restart tor
|
|
||||||
```
|
|
||||||
|
|
11
HACKING.md
11
HACKING.md
|
@ -30,6 +30,8 @@ apt install git cmake build-essential ccache libssl-dev libunbound-dev libboost-
|
||||||
|
|
||||||
#### macOS
|
#### macOS
|
||||||
|
|
||||||
|
For macOS it's easiest to leverage [brew](https://brew.sh) to install the required dependencies.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew install qt libsodium libzip qrencode unbound cmake boost hidapi openssl expat libunwind-headers protobuf pkgconfig zbar
|
brew install qt libsodium libzip qrencode unbound cmake boost hidapi openssl expat libunwind-headers protobuf pkgconfig zbar
|
||||||
```
|
```
|
||||||
|
@ -84,7 +86,7 @@ cd feather
|
||||||
git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
```
|
```
|
||||||
|
|
||||||
### Jetbrains Clion
|
### Jetbrains Clion (IDE)
|
||||||
|
|
||||||
We recommend using Jetbrains Clion for Feather development. It integrates nicely with CMake and comes with a built-in
|
We recommend using Jetbrains Clion for Feather development. It integrates nicely with CMake and comes with a built-in
|
||||||
debugger.
|
debugger.
|
||||||
|
@ -104,6 +106,13 @@ You can add any environment variables and program arguments here:
|
||||||
|
|
||||||
After the target is configured, `Run -> Run 'feather'` or press Shift + F10 to build Feather.
|
After the target is configured, `Run -> Run 'feather'` or press Shift + F10 to build Feather.
|
||||||
|
|
||||||
|
### Building without IDE
|
||||||
|
|
||||||
|
To build Feather without an IDE:
|
||||||
|
|
||||||
|
- Linux: `make release`
|
||||||
|
- macOS: `make mac-release`
|
||||||
|
|
||||||
### CMake
|
### CMake
|
||||||
|
|
||||||
There are some CMake options that you may pass to control how Feather is built:
|
There are some CMake options that you may pass to control how Feather is built:
|
||||||
|
|
18
README.md
18
README.md
|
@ -14,20 +14,24 @@ Copyright (c) 2020-2022, The Monero Project.
|
||||||
* IRC: `#feather` on OFTC
|
* IRC: `#feather` on OFTC
|
||||||
* Matrix: `#feather:monero.social`
|
* Matrix: `#feather:monero.social`
|
||||||
|
|
||||||
Download the latest release [here](https://featherwallet.org/download).
|
**Download** the latest release [here](https://featherwallet.org/download).
|
||||||
|
|
||||||
## Compiling Feather from source
|
|
||||||
|
|
||||||
See [BUILDING.md](https://github.com/feather-wallet/feather/blob/master/BUILDING.md) for information on how to build from source.
|
|
||||||
|
|
||||||
## Supporting the project
|
## Supporting the project
|
||||||
|
|
||||||
Feather is a 100% community-sponsored project. If you want to join our efforts, the easiest thing you can do is support the project financially.
|
Feather is a 100% community-sponsored project. If you want to join our efforts, the easiest thing you can do is support the project financially.
|
||||||
|
|
||||||
|
Donations help pay for hosting, build servers, domain names, e-mail and other recurring costs. Any amount helps.
|
||||||
|
|
||||||
`47ntfT2Z5384zku39pTM6hGcnLnvpRYW2Azm87GiAAH2bcTidtq278TL6HmwyL8yjMeERqGEBs3cqC8vvHPJd1cWQrGC65f`
|
`47ntfT2Z5384zku39pTM6hGcnLnvpRYW2Azm87GiAAH2bcTidtq278TL6HmwyL8yjMeERqGEBs3cqC8vvHPJd1cWQrGC65f`
|
||||||
|
|
||||||
|
## Building from source
|
||||||
|
|
||||||
|
See [BUILDING.md](https://github.com/feather-wallet/feather/blob/master/BUILDING.md) for information on how to build from source.
|
||||||
|
|
||||||
## Developers
|
## Developers
|
||||||
|
|
||||||
See [HACKING.md](https://github.com/feather-wallet/feather/blob/master/HACKING.md) for useful development resources.
|
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).
|
||||||
|
|
||||||
It is HIGHLY recommended that you join the `#feather` IRC channel on OFTC if you are hacking on Feather. Due to the nature of this open source software project, joining this channel and idling is the best way to stay updated on best practices and new developments.
|
It is highly recommended that you join the `#feather` IRC channel on OFTC or `#feather:monero.social` on Matrix if you
|
||||||
|
are hacking on Feather. Due to the nature of this open source software project, idling in this channel is the best
|
||||||
|
way to stay updated on best practices and new developments.
|
||||||
|
|
Loading…
Reference in a new issue