From 91e924d8d53148d2af60949e0fc63bbdf463145c Mon Sep 17 00:00:00 2001 From: Rene Vergara Date: Tue, 3 Jan 2023 14:34:12 -0600 Subject: [PATCH] Improve installation instructions --- CHANGELOG.md | 14 ++++++++++---- README.md | 11 ++++++++++- package.yaml | 2 +- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92d11d7..68864f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.3.2] + +### Changed + +- Updated README with dependencies and instructions for submodule. + ### Fixed - Sending transactions to transparent addresses, removing the memo and using the `AllowRevealedRecipients` privacy policy. -## [0.3.1.0] +## [0.3.1] ### Added @@ -21,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Improved `encodeHexText` to handle Unicode characters correctly. -## [0.3.0.0] +## [0.3.0] ### Changed @@ -31,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Displaying transactions for view-only addresses -## [0.2.0.0] +## [0.2.0] ### Added @@ -43,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Changes the use of `checkOpResult` to be recursive until the transaction either fails or succeeds. -## [0.1.0.0] +## [0.1.0] ### Added diff --git a/README.md b/README.md index 04d1afd..c87ea24 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,22 @@ Note: Zenith depends on a patched version of the `haskoin-core` Haskell package ## Installation -- Clone the repository. - Install dependencies: - [Stack](https://docs.haskellstack.org/en/stable/README/#how-to-install) - [Zcash Full Node v.5.0.0](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html#install) - `xclip` - `libsecp256k1-dev` - `libxss-dev` + - `libxrandr-dev` +- Clone the repository. + +```bash +git clone https://git.vergara.tech/Vergara_Tech/zenith.git +cd zenith +git submodule init +git submodule update +``` + - Install using `stack`: ``` diff --git a/package.yaml b/package.yaml index baabe12..604e7c2 100644 --- a/package.yaml +++ b/package.yaml @@ -1,5 +1,5 @@ name: zenith -version: 0.3.1.0 +version: 0.3.2 git: "https://gitlab.com/pitmutt/zenith" license: BOSL author: "Rene Vergara"