]> Nutra Git (v2) - gamesguru/feather.git/commitdiff
More docs updates
authortobtoht <thotbot@protonmail.com>
Thu, 26 May 2022 16:58:54 +0000 (18:58 +0200)
committertobtoht <thotbot@protonmail.com>
Thu, 26 May 2022 16:58:54 +0000 (18:58 +0200)
BUILDING.md
HACKING.md
README.md

index 735c94f8a319781b2288f97d8c426e3947f5e4df..32c24de8d21745196b508beebfca4c6c5feae956 100644 (file)
@@ -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:
 
@@ -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/`.
 
----
-
-## Building on macOS
-
-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.
+### macOS
 
-```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
-```
\ No newline at end of file
+Docker builds for macOS are not currently supported. To build Feather on macOS follow the steps in [HACKING.md](HACKING.md).
index 29b6bc1508e840f22249668e37bc7eb1024de00a..53637029da8165173b98b1dbf60095ce52b4e77e 100644 (file)
@@ -30,6 +30,8 @@ apt install git cmake build-essential ccache libssl-dev libunbound-dev libboost-
 
 #### macOS
 
+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
 ```
@@ -84,7 +86,7 @@ cd feather
 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
 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.
 
+### Building without IDE
+
+To build Feather without an IDE:
+
+- Linux: `make release`
+- macOS: `make mac-release`
+
 ### CMake
 
 There are some CMake options that you may pass to control how Feather is built:
index 906a2fa450b2e6469c90777cc06200bc2544a55b..3fef8f508920e200a691ace639c2293b55c35c6a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,20 +14,24 @@ Copyright (c) 2020-2022, The Monero Project.
 * IRC: `#feather` on OFTC
 * Matrix: `#feather:monero.social`
 
-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.
+**Download** the latest release [here](https://featherwallet.org/download).
 
 ## 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.
 
+Donations help pay for hosting, build servers, domain names, e-mail and other recurring costs. Any amount helps.
+
 `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
 
-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.