From d0e4c70d0327ac04265d47970562e8777734a2de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:02:18 +0000 Subject: [PATCH 01/20] adding badges add workflow badges and standardised the bash instructions --- README.md | 85 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 44 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 1cba2e04..2bcf03c7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ ![image](https://github.com/ConcealNetwork/conceal-imagery/blob/master/logos/splash.png) -![](https://github.com/bomb-on/conceal-core/workflows/Ubuntu%2016.04/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/Ubuntu%2018.04/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/Windows/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/macOS/badge.svg) +[![Ubuntu 20.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml) +[![Ubuntu 18.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml) +[![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) +[![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) # Conceal Core (CLI) Latest Release: v6.5.1 -Maintained by Conceal Developers. +Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. ## Information Conceal Network is a secure peer-to-peer privacy framework empowering individuals and organizations to anonymously communicate and interact financially in a decentralized and censorship resistant ecosystem. @@ -38,21 +41,21 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB - Ubuntu / Linux ```bash - sudo fallocate -l 5G /swapfile - sudo chmod 600 /swapfile - sudo mkswap /swapfile - sudo swapon /swapfile + $ sudo fallocate -l 5G /swapfile + $ sudo chmod 600 /swapfile + $ sudo mkswap /swapfile + $ sudo swapon /swapfile ``` - Rasberry Pi OS ```bash - sudo dphys-swapfile swapoff - sudo nano /etc/dphys-swapfile - CONF_SWAPSIZE=5120 - sudo nano /sbin/dphys-swapfile - #CONF_MAXSWAP=2048 - sudo dphys-swapfile setup - sudo dphys-swapfile swapon + $ sudo dphys-swapfile swapoff + $ sudo nano /etc/dphys-swapfile + $ CONF_SWAPSIZE=5120 + $ sudo nano /sbin/dphys-swapfile + $ #CONF_MAXSWAP=2048 + $ sudo dphys-swapfile setup + $ sudo dphys-swapfile swapon ``` ### Linux / Ubuntu / Debian @@ -61,18 +64,18 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB - You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make. - On Ubuntu: - ``` - sudo apt update - sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev + ```bash + $ sudo apt update + $ sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev ``` #### Building -- `git clone https://github.com/ConcealNetwork/conceal-core` -- `cd conceal-core` -- `mkdir build && cd $_` -- `cmake ..` -- `make` +git clone https://github.com/ConcealNetwork/conceal-core` +cd conceal-core` +mkdir build && cd $_` +cmake ..` +make` If the build is successful the binaries will be in the `src` folder. @@ -97,13 +100,13 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. -```bash -git clone https://github.com/ConcealNetwork/conceal-core -cd conceal-core -mkdir build -cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" -msbuild concealX.sln /p:Configuration=Release /m -``` + ```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build + cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" + msbuild concealX.sln /p:Configuration=Release /m + ``` If the build is successful the binaries will be in the `src/Release` folder. @@ -114,29 +117,29 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: -```bash -$ xcode-select --install -``` + ```bash + $ xcode-select --install + ``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. After that, proceed with installing dependencies: -```bash -$ brew install git python cmake gcc boost -``` + ```bash + $ brew install git python cmake gcc boost + ``` #### Building When all dependencies are installed, build Conceal Core binaries: -```bash -$ git clone https://github.com/ConcealNetwork/conceal-core -$ cd conceal-core -$ mkdir build && cd $_ -$ cmake .. -$ make -``` + ```bash + $ git clone https://github.com/ConcealNetwork/conceal-core + $ cd conceal-core + $ mkdir build && cd $_ + $ cmake .. + $ make + ``` If the build is successful the binaries will be located in `src` directory. From c9df7c074444752146b53e86013597b0521a20d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:19:06 +0000 Subject: [PATCH 02/20] fixed typo fixed typo in bash instructions --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2bcf03c7..db48a1cd 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,13 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Building -git clone https://github.com/ConcealNetwork/conceal-core` -cd conceal-core` -mkdir build && cd $_` -cmake ..` -make` + ```bash + $ git clone https://github.com/ConcealNetwork/conceal-core` + $ cd conceal-core + $ mkdir build && cd $_ + $ cmake .. + $ make + ``` If the build is successful the binaries will be in the `src` folder. From 1693d4ed4ceaec5ff2079e284fcb03b8fa3441ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:19:55 +0000 Subject: [PATCH 03/20] typo fixed typo in building instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index db48a1cd..613e48dc 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Building ```bash - $ git clone https://github.com/ConcealNetwork/conceal-core` + $ git clone https://github.com/ConcealNetwork/conceal-core $ cd conceal-core $ mkdir build && cd $_ $ cmake .. From 9a365b966dbcc4b9e5a6b15a508acadc98eed7d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:40:01 +0000 Subject: [PATCH 04/20] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 613e48dc..7d4e29f6 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ After that, proceed with installing dependencies: When all dependencies are installed, build Conceal Core binaries: - ```bash + ``` $ git clone https://github.com/ConcealNetwork/conceal-core $ cd conceal-core $ mkdir build && cd $_ From f075366d61d5b082eb846d615108b5f32de58d0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:41:00 +0000 Subject: [PATCH 05/20] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d4e29f6..9f493763 100644 --- a/README.md +++ b/README.md @@ -135,13 +135,13 @@ After that, proceed with installing dependencies: When all dependencies are installed, build Conceal Core binaries: - ``` +``` $ git clone https://github.com/ConcealNetwork/conceal-core $ cd conceal-core $ mkdir build && cd $_ $ cmake .. $ make - ``` +``` If the build is successful the binaries will be located in `src` directory. From 5242b887095a7c823028964b32a3b422f461b3f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 13:42:06 +0000 Subject: [PATCH 06/20] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f493763..cfe188b2 100644 --- a/README.md +++ b/README.md @@ -128,8 +128,8 @@ On newer macOS versions (v10.14 and higher) this step is done through Software U After that, proceed with installing dependencies: ```bash - $ brew install git python cmake gcc boost - ``` + $ brew install git python cmake gcc boost``` + #### Building From 1b2ea7f4d453add08b69d04fbd5823bd66698d86 Mon Sep 17 00:00:00 2001 From: AxVultis Date: Thu, 11 Nov 2021 15:33:24 +0100 Subject: [PATCH 07/20] Fix GitHub Actions release upload --- .github/workflows/check.yml | 24 ++++++++++++------------ .github/workflows/macOS.yml | 16 +++++++++------- .github/workflows/ubuntu18.yml | 18 ++++++++++-------- .github/workflows/ubuntu20.yml | 18 ++++++++++-------- .github/workflows/windows.yml | 16 +++++++++------- 5 files changed, 50 insertions(+), 42 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 24b85e38..2e142475 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -34,8 +34,8 @@ jobs: run: | $build_folder = "build" $sha = "${{ github.sha }}" - $ccx_ver = $sha.SubString(0,7) - $release_name = "ccx-cli-win64-v$ccx_ver" + $ccx_version = $sha.SubString(0,7) + $release_name = "ccx-cli-win64-v$ccx_version" mkdir "$build_folder" cd "$build_folder" cmake -G "Visual Studio 16 2019" .. @@ -49,7 +49,7 @@ jobs: echo "::set-output name=sha256::${sha256}" echo "::set-output name=release_name::${release_name}.zip" echo "::set-output name=asset_path::${asset_path}" - echo "::set-output name=ccx_ver::${ccx_ver}" + echo "::set-output name=ccx_version::${ccx_version}" echo "::set-output name=artifact_path::$build_folder/src/Release/$release_name" - name: Upload To GH Artifacts @@ -72,9 +72,9 @@ jobs: sudo apt-get update sudo apt-get install -y libboost-all-dev build_folder="build/debug" - ccx_ver=${GITHUB_SHA::7} - ccx_ver_folder=$(echo $ccx_ver | sed 's/\.//g') - release_name=ccx-cli-ubuntu-1804-dev"$ccx_ver" + ccx_version=${GITHUB_SHA::7} + ccx_ver_folder=$(echo $ccx_version | sed 's/\.//g') + release_name=ccx-cli-ubuntu-1804-dev"$ccx_version" mkdir -p "$build_folder" cd "$build_folder" cmake ../.. -DCMAKE_BUILD_TYPE=Debug @@ -107,9 +107,9 @@ jobs: sudo apt-get update sudo apt-get install -y libboost-all-dev build_folder="build/debug" - ccx_ver=${GITHUB_SHA::7} - ccx_ver_folder=$(echo $ccx_ver | sed 's/\.//g') - release_name=ccx-cli-ubuntu-2004-dev"$ccx_ver" + ccx_version=${GITHUB_SHA::7} + ccx_ver_folder=$(echo $ccx_version | sed 's/\.//g') + release_name=ccx-cli-ubuntu-2004-dev"$ccx_version" mkdir -p "$build_folder" cd "$build_folder" cmake ../.. -DCMAKE_BUILD_TYPE=Debug @@ -140,9 +140,9 @@ jobs: id: build run: | build_folder="build/" - ccx_ver=${GITHUB_SHA::7} - ccx_ver_folder=$(echo $ccx_ver | sed 's/\.//g') - release_name=ccx-cli-macos-dev"$ccx_ver" + ccx_version=${GITHUB_SHA::7} + ccx_ver_folder=$(echo $ccx_version | sed 's/\.//g') + release_name=ccx-cli-macos-dev"$ccx_version" brew install gcc boost mkdir "$build_folder" cd "$build_folder" diff --git a/.github/workflows/macOS.yml b/.github/workflows/macOS.yml index 4cfae662..55004d00 100644 --- a/.github/workflows/macOS.yml +++ b/.github/workflows/macOS.yml @@ -16,8 +16,8 @@ jobs: id: build run: | build_folder="build/" - ccx_ver=$(echo ${{ github.ref }} | sed 's|refs/tags/||') - release_name="ccx-cli-macOS-v$ccx_ver" + ccx_version=$(echo ${{ github.ref }} | sed 's|refs/tags/||') + release_name="ccx-cli-macOS-v$ccx_version" brew install gcc boost mkdir "$build_folder" cd "$build_folder" @@ -33,15 +33,17 @@ jobs: echo "::set-output name=sha256::${sha256}" echo "::set-output name=release_name::${release_name}.zip" echo "::set-output name=asset_path::${asset_path}" - echo "::set-output name=ccx_ver::${ccx_ver}" + echo "::set-output name=ccx_version::${ccx_version}" + # since https://github.com/softprops/action-gh-release/pull/145 body is replaced instead of being appended + # use v0.1.12 for now - name: Create Release - uses: softprops/action-gh-release@v1 + uses: softprops/action-gh-release@v0.1.12 with: files: ${{ steps.build.outputs.asset_path }} - name: Conceal Core CLI v${{ steps.build.outputs.ccx_ver }} + name: Conceal Core CLI v${{ steps.build.outputs.ccx_version }} body: | - **${{ steps.build.outputs.release_name }}** - ${{ steps.build.outputs.sha256 }} + [Download for macOS](../../releases/download/${{ steps.build.outputs.ccx_version }}/${{ steps.build.outputs.release_name }}) **${{ steps.build.outputs.release_name }}** + `SHA256 : ${{ steps.build.outputs.sha256 }}` env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/ubuntu18.yml b/.github/workflows/ubuntu18.yml index 9bd39524..9d5de5bb 100644 --- a/.github/workflows/ubuntu18.yml +++ b/.github/workflows/ubuntu18.yml @@ -18,9 +18,9 @@ jobs: sudo apt-get update sudo apt-get install -y libboost-all-dev build_folder="build/debug" - ccx_ver=$(echo "$GITHUB_REF" | sed 's|refs/tags/||') - ccx_ver_folder=$(echo $ccx_ver | sed 's/\.//g') - release_name=ccx-cli-ubuntu-1804-v"$ccx_ver" + ccx_version=$(echo "$GITHUB_REF" | sed 's|refs/tags/||') + ccx_ver_folder=$(echo $ccx_version | sed 's/\.//g') + release_name=ccx-cli-ubuntu-1804-v"$ccx_version" mkdir -p "$build_folder" cd "$build_folder" cmake ../.. @@ -36,15 +36,17 @@ jobs: echo "::set-output name=sha256::${sha256}" echo "::set-output name=release_name::${release_name}.tar.gz" echo "::set-output name=asset_path::${asset_path}" - echo "::set-output name=ccx_ver::${ccx_ver}" + echo "::set-output name=ccx_version::${ccx_version}" + # since https://github.com/softprops/action-gh-release/pull/145 body is replaced instead of being appended + # use v0.1.12 for now - name: Create Release - uses: softprops/action-gh-release@v1 + uses: softprops/action-gh-release@v0.1.12 with: files: ${{ steps.build.outputs.asset_path }} - name: Conceal Core CLI v${{ steps.build.outputs.ccx_ver }} + name: Conceal Core CLI v${{ steps.build.outputs.ccx_version }} body: | - **${{ steps.build.outputs.release_name }}** - ${{ steps.build.outputs.sha256 }} + [Download for Ubuntu 18.04](../../releases/download/${{ steps.build.outputs.ccx_version }}/${{ steps.build.outputs.release_name }}) **${{ steps.build.outputs.release_name }}** + `SHA256 : ${{ steps.build.outputs.sha256 }}` env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/ubuntu20.yml b/.github/workflows/ubuntu20.yml index e0ee7304..a02a6fd8 100644 --- a/.github/workflows/ubuntu20.yml +++ b/.github/workflows/ubuntu20.yml @@ -22,9 +22,9 @@ jobs: sudo apt-get update sudo apt-get install -y libboost-all-dev build_folder="build/debug" - ccx_ver=$(echo "$GITHUB_REF" | sed 's|refs/tags/||') - ccx_ver_folder=$(echo $ccx_ver | sed 's/\.//g') - release_name=ccx-cli-ubuntu-2004-v"$ccx_ver" + ccx_version=$(echo "$GITHUB_REF" | sed 's|refs/tags/||') + ccx_ver_folder=$(echo $ccx_version | sed 's/\.//g') + release_name=ccx-cli-ubuntu-2004-v"$ccx_version" mkdir -p "$build_folder" cd "$build_folder" cmake ../.. @@ -40,15 +40,17 @@ jobs: echo "::set-output name=sha256::${sha256}" echo "::set-output name=release_name::${release_name}.tar.gz" echo "::set-output name=asset_path::${asset_path}" - echo "::set-output name=ccx_ver::${ccx_ver}" + echo "::set-output name=ccx_version::${ccx_version}" + # since https://github.com/softprops/action-gh-release/pull/145 body is replaced instead of being appended + # use v0.1.12 for now - name: Create Release - uses: softprops/action-gh-release@v1 + uses: softprops/action-gh-release@v0.1.12 with: files: ${{ steps.build.outputs.asset_path }} - name: Conceal Core CLI v${{ steps.build.outputs.ccx_ver }} + name: Conceal Core CLI v${{ steps.build.outputs.ccx_version }} body: | - **${{ steps.build.outputs.release_name }}** - ${{ steps.build.outputs.sha256 }} + [Download for Ubuntu 20.04](../../releases/download/${{ steps.build.outputs.ccx_version }}/${{ steps.build.outputs.release_name }}) **${{ steps.build.outputs.release_name }}** + `SHA256 : ${{ steps.build.outputs.sha256 }}` env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml index b779f19b..810d9012 100644 --- a/.github/workflows/windows.yml +++ b/.github/workflows/windows.yml @@ -30,8 +30,8 @@ jobs: id: build run: | $build_folder = "build" - $ccx_ver = "${{ github.ref }}" -replace 'refs/tags/' - $release_name = "ccx-cli-win64-v$ccx_ver" + $ccx_version = "${{ github.ref }}" -replace 'refs/tags/' + $release_name = "ccx-cli-win64-v$ccx_version" mkdir "$build_folder" cd "$build_folder" cmake -G "Visual Studio 16 2019" .. @@ -45,15 +45,17 @@ jobs: echo "::set-output name=sha256::${sha256}" echo "::set-output name=release_name::${release_name}.zip" echo "::set-output name=asset_path::${asset_path}" - echo "::set-output name=ccx_ver::${ccx_ver}" + echo "::set-output name=ccx_version::${ccx_version}" + # since https://github.com/softprops/action-gh-release/pull/145 body is replaced instead of being appended + # use v0.1.12 for now - name: Create Release - uses: softprops/action-gh-release@v1 + uses: softprops/action-gh-release@v0.1.12 with: files: ${{ steps.build.outputs.asset_path }} - name: Conceal Core CLI v${{ steps.build.outputs.ccx_ver }} + name: Conceal Core CLI v${{ steps.build.outputs.ccx_version }} body: | - **${{ steps.build.outputs.release_name }}** - ${{ steps.build.outputs.sha256 }} + [Download for Windows](../../releases/download/${{ steps.build.outputs.ccx_version }}/${{ steps.build.outputs.release_name }}) **${{ steps.build.outputs.release_name }}** + `SHA256 : ${{ steps.build.outputs.sha256 }}` env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 7bc98929fdd3747b8806b89790d82edf76563df4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 14:48:11 +0000 Subject: [PATCH 08/20] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cfe188b2..3b55c042 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ ![image](https://github.com/ConcealNetwork/conceal-imagery/blob/master/logos/splash.png) +# Conceal Core (CLI) +Latest Release: v6.5.1 [![Ubuntu 20.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml) [![Ubuntu 18.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml) [![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) [![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) -# Conceal Core (CLI) -Latest Release: v6.5.1 - Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. ## Information @@ -40,7 +39,7 @@ In some build scenarios it may be necessary to increase the size of the SWAP to For example if you have 8GB of RAM, then your SWAP size should be 5GB - Ubuntu / Linux - ```bash + ``` $ sudo fallocate -l 5G /swapfile $ sudo chmod 600 /swapfile $ sudo mkswap /swapfile From 1c90d16ae457f5e114caf2488daa5b4dc997ec70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:21:33 +0000 Subject: [PATCH 09/20] Update README.md --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3b55c042..b6aa6450 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,15 @@ In some build scenarios it may be necessary to increase the size of the SWAP to For example if you have 8GB of RAM, then your SWAP size should be 5GB - Ubuntu / Linux - ``` +``` $ sudo fallocate -l 5G /swapfile $ sudo chmod 600 /swapfile $ sudo mkswap /swapfile $ sudo swapon /swapfile - ``` +``` - Rasberry Pi OS - ```bash +``` $ sudo dphys-swapfile swapoff $ sudo nano /etc/dphys-swapfile $ CONF_SWAPSIZE=5120 @@ -55,7 +55,7 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB $ #CONF_MAXSWAP=2048 $ sudo dphys-swapfile setup $ sudo dphys-swapfile swapon - ``` +``` ### Linux / Ubuntu / Debian @@ -63,20 +63,20 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB - You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make. - On Ubuntu: - ```bash +``` $ sudo apt update $ sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev - ``` +``` #### Building - ```bash +``` $ git clone https://github.com/ConcealNetwork/conceal-core $ cd conceal-core $ mkdir build && cd $_ $ cmake .. $ make - ``` +``` If the build is successful the binaries will be in the `src` folder. @@ -101,13 +101,13 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. - ```bash +``` git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core mkdir build cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" msbuild concealX.sln /p:Configuration=Release /m - ``` +``` If the build is successful the binaries will be in the `src/Release` folder. @@ -118,16 +118,17 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: - ```bash +``` $ xcode-select --install - ``` +``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. After that, proceed with installing dependencies: - ```bash - $ brew install git python cmake gcc boost``` +```bash + $ brew install git python cmake gcc boost +``` #### Building From 76f24eec6b903e22c10fa856dc614eda6a881e06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:22:42 +0000 Subject: [PATCH 10/20] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b6aa6450..f181d794 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Latest Release: v6.5.1 [![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) [![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) + Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. ## Information From 1499457f4e97e25c1d6e3f5303d2feabc621352f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:23:32 +0000 Subject: [PATCH 11/20] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index f181d794..7c6cd29d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ ![image](https://github.com/ConcealNetwork/conceal-imagery/blob/master/logos/splash.png) # Conceal Core (CLI) -Latest Release: v6.5.1 [![Ubuntu 20.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml) [![Ubuntu 18.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml) [![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) [![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) - +Latest Release: v6.5.1 Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. From a8adaa9b9de1e5e24aa07f90c378e03a2494016d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:24:10 +0000 Subject: [PATCH 12/20] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7c6cd29d..3bc7833c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Ubuntu 18.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml) [![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) [![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) + Latest Release: v6.5.1 Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. From 38049e38ee619172286d4a9d5bc7e8421c9a773d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:25:27 +0000 Subject: [PATCH 13/20] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bc7833c..b18f8bc6 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,13 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. -``` + ``` git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core mkdir build cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" msbuild concealX.sln /p:Configuration=Release /m -``` + ``` If the build is successful the binaries will be in the `src/Release` folder. From e6044d39136dd3cc2ce4303b3e437126372208b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:26:18 +0000 Subject: [PATCH 14/20] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b18f8bc6..2abb3043 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,13 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. - ``` - git clone https://github.com/ConcealNetwork/conceal-core - cd conceal-core - mkdir build - cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" - msbuild concealX.sln /p:Configuration=Release /m - ``` +``` + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build + cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" + msbuild concealX.sln /p:Configuration=Release /m +``` If the build is successful the binaries will be in the `src/Release` folder. From 25e619bb4363c5d5ba3c0f152a7bd70e963cecb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 15:44:45 +0000 Subject: [PATCH 15/20] Update Readme (#226) Added workflow badges and standardised the bash instructions --- README.md | 90 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 48 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 1cba2e04..2abb3043 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ ![image](https://github.com/ConcealNetwork/conceal-imagery/blob/master/logos/splash.png) -![](https://github.com/bomb-on/conceal-core/workflows/Ubuntu%2016.04/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/Ubuntu%2018.04/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/Windows/badge.svg) ![](https://github.com/bomb-on/conceal-core/workflows/macOS/badge.svg) - # Conceal Core (CLI) +[![Ubuntu 20.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu20.yml) +[![Ubuntu 18.04](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/ubuntu18.yml) +[![Windows](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/windows.yml) +[![macOS](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml/badge.svg)](https://github.com/ConcealNetwork/conceal-core/actions/workflows/macOS.yml) + Latest Release: v6.5.1 -Maintained by Conceal Developers. +Maintained by Conceal Developers, overseen by Conceal Team and driven by Conceal Community. ## Information Conceal Network is a secure peer-to-peer privacy framework empowering individuals and organizations to anonymously communicate and interact financially in a decentralized and censorship resistant ecosystem. @@ -37,23 +40,23 @@ In some build scenarios it may be necessary to increase the size of the SWAP to For example if you have 8GB of RAM, then your SWAP size should be 5GB - Ubuntu / Linux - ```bash - sudo fallocate -l 5G /swapfile - sudo chmod 600 /swapfile - sudo mkswap /swapfile - sudo swapon /swapfile - ``` +``` + $ sudo fallocate -l 5G /swapfile + $ sudo chmod 600 /swapfile + $ sudo mkswap /swapfile + $ sudo swapon /swapfile +``` - Rasberry Pi OS - ```bash - sudo dphys-swapfile swapoff - sudo nano /etc/dphys-swapfile - CONF_SWAPSIZE=5120 - sudo nano /sbin/dphys-swapfile - #CONF_MAXSWAP=2048 - sudo dphys-swapfile setup - sudo dphys-swapfile swapon - ``` +``` + $ sudo dphys-swapfile swapoff + $ sudo nano /etc/dphys-swapfile + $ CONF_SWAPSIZE=5120 + $ sudo nano /sbin/dphys-swapfile + $ #CONF_MAXSWAP=2048 + $ sudo dphys-swapfile setup + $ sudo dphys-swapfile swapon +``` ### Linux / Ubuntu / Debian @@ -61,18 +64,20 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB - You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make. - On Ubuntu: - ``` - sudo apt update - sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev - ``` +``` + $ sudo apt update + $ sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev +``` #### Building -- `git clone https://github.com/ConcealNetwork/conceal-core` -- `cd conceal-core` -- `mkdir build && cd $_` -- `cmake ..` -- `make` +``` + $ git clone https://github.com/ConcealNetwork/conceal-core + $ cd conceal-core + $ mkdir build && cd $_ + $ cmake .. + $ make +``` If the build is successful the binaries will be in the `src` folder. @@ -97,12 +102,12 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. -```bash -git clone https://github.com/ConcealNetwork/conceal-core -cd conceal-core -mkdir build -cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" -msbuild concealX.sln /p:Configuration=Release /m +``` + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build + cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" + msbuild concealX.sln /p:Configuration=Release /m ``` If the build is successful the binaries will be in the `src/Release` folder. @@ -114,8 +119,8 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: -```bash -$ xcode-select --install +``` + $ xcode-select --install ``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. @@ -123,19 +128,20 @@ On newer macOS versions (v10.14 and higher) this step is done through Software U After that, proceed with installing dependencies: ```bash -$ brew install git python cmake gcc boost + $ brew install git python cmake gcc boost ``` + #### Building When all dependencies are installed, build Conceal Core binaries: -```bash -$ git clone https://github.com/ConcealNetwork/conceal-core -$ cd conceal-core -$ mkdir build && cd $_ -$ cmake .. -$ make +``` + $ git clone https://github.com/ConcealNetwork/conceal-core + $ cd conceal-core + $ mkdir build && cd $_ + $ cmake .. + $ make ``` If the build is successful the binaries will be located in `src` directory. From 734c1a73f19187aca20f8f3ea86da2a866be382f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 16:06:52 +0000 Subject: [PATCH 16/20] Update README.md fixed batch instructions and added ryo devs to `special thanks` section --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 2abb3043..d6755154 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,12 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Building -``` - $ git clone https://github.com/ConcealNetwork/conceal-core - $ cd conceal-core - $ mkdir build && cd $_ - $ cmake .. - $ make +```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build && cd $_ + cmake .. + make ``` If the build is successful the binaries will be in the `src` folder. @@ -119,32 +119,32 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: -``` - $ xcode-select --install +```bash + xcode-select --install ``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. After that, proceed with installing dependencies: -```bash - $ brew install git python cmake gcc boost -``` + ```bash + brew install git python cmake gcc boost + ``` #### Building When all dependencies are installed, build Conceal Core binaries: -``` - $ git clone https://github.com/ConcealNetwork/conceal-core - $ cd conceal-core - $ mkdir build && cd $_ - $ cmake .. - $ make -``` + ```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build && cd $_ + cmake .. + make + ``` If the build is successful the binaries will be located in `src` directory. #### Special Thanks -Special thanks goes out to the developers from Cryptonote, Bytecoin, Monero, Forknote, TurtleCoin, Karbo and Masari. +Special thanks goes out to the developers from Cryptonote, Bytecoin, Ryo, Monero, Forknote, TurtleCoin, Karbo and Masari. From 281ea22ca758d0955bc55116ca0afd8d7056f6df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 16:34:24 +0000 Subject: [PATCH 17/20] Update README.md Fixed workflow badges and updated bash instructions --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 08fdc762..d6755154 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,12 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Building - ```bash git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core mkdir build && cd $_ cmake .. make - ``` If the build is successful the binaries will be in the `src` folder. @@ -146,7 +144,6 @@ When all dependencies are installed, build Conceal Core binaries: make ``` - If the build is successful the binaries will be located in `src` directory. #### Special Thanks From 80b74a7ff829426873edca80bef571a992d6d39c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 16:46:09 +0000 Subject: [PATCH 18/20] Fixed workflow badges and updated bash instructions (#230) Fixed workflow badges and updated bash instructions --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 2abb3043..d6755154 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,12 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Building -``` - $ git clone https://github.com/ConcealNetwork/conceal-core - $ cd conceal-core - $ mkdir build && cd $_ - $ cmake .. - $ make +```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build && cd $_ + cmake .. + make ``` If the build is successful the binaries will be in the `src` folder. @@ -119,32 +119,32 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: -``` - $ xcode-select --install +```bash + xcode-select --install ``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. After that, proceed with installing dependencies: -```bash - $ brew install git python cmake gcc boost -``` + ```bash + brew install git python cmake gcc boost + ``` #### Building When all dependencies are installed, build Conceal Core binaries: -``` - $ git clone https://github.com/ConcealNetwork/conceal-core - $ cd conceal-core - $ mkdir build && cd $_ - $ cmake .. - $ make -``` + ```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build && cd $_ + cmake .. + make + ``` If the build is successful the binaries will be located in `src` directory. #### Special Thanks -Special thanks goes out to the developers from Cryptonote, Bytecoin, Monero, Forknote, TurtleCoin, Karbo and Masari. +Special thanks goes out to the developers from Cryptonote, Bytecoin, Ryo, Monero, Forknote, TurtleCoin, Karbo and Masari. From 577a6c2dadcd548c4103d195bd152c20f353a2a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 16:51:44 +0000 Subject: [PATCH 19/20] Update README.md --- README.md | 59 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d6755154..5131f38c 100644 --- a/README.md +++ b/README.md @@ -40,23 +40,23 @@ In some build scenarios it may be necessary to increase the size of the SWAP to For example if you have 8GB of RAM, then your SWAP size should be 5GB - Ubuntu / Linux -``` - $ sudo fallocate -l 5G /swapfile - $ sudo chmod 600 /swapfile - $ sudo mkswap /swapfile - $ sudo swapon /swapfile -``` + ```bash + sudo fallocate -l 5G /swapfile + sudo chmod 600 /swapfile + sudo mkswap /swapfile + sudo swapon /swapfile + ``` - Rasberry Pi OS -``` - $ sudo dphys-swapfile swapoff - $ sudo nano /etc/dphys-swapfile - $ CONF_SWAPSIZE=5120 - $ sudo nano /sbin/dphys-swapfile - $ #CONF_MAXSWAP=2048 - $ sudo dphys-swapfile setup - $ sudo dphys-swapfile swapon -``` + ``` + sudo dphys-swapfile swapoff + sudo nano /etc/dphys-swapfile + CONF_SWAPSIZE=5120 + sudo nano /sbin/dphys-swapfile + #CONF_MAXSWAP=2048 + sudo dphys-swapfile setup + sudo dphys-swapfile swapon + ``` ### Linux / Ubuntu / Debian @@ -64,20 +64,19 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB - You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make. - On Ubuntu: -``` - $ sudo apt update + ```bash + sudo apt update $ sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev -``` + ``` #### Building - -```bash + ```bash git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core mkdir build && cd $_ cmake .. make -``` + ``` If the build is successful the binaries will be in the `src` folder. @@ -102,13 +101,13 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. -``` - git clone https://github.com/ConcealNetwork/conceal-core - cd conceal-core - mkdir build - cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" - msbuild concealX.sln /p:Configuration=Release /m -``` + ```bash + git clone https://github.com/ConcealNetwork/conceal-core + cd conceal-core + mkdir build + cmake .. -G "Visual Studio 16 2019" -A x64 -DBOOST_LIBRARYDIR="c:\local\boost_1_73_0\lib64-msvc-14.2" + msbuild concealX.sln /p:Configuration=Release /m + ``` If the build is successful the binaries will be in the `src/Release` folder. @@ -119,9 +118,9 @@ If the build is successful the binaries will be in the `src/Release` folder. In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: -```bash + ```bash xcode-select --install -``` + ``` On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. From 6eb63e468d25ccea7e9c2fd901f81bc14d94b743 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98x?= <35565671+krypt0x@users.noreply.github.com> Date: Thu, 11 Nov 2021 17:16:43 +0000 Subject: [PATCH 20/20] Updated bash instructions (#231) Updated bash instructions --- README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5131f38c..b3ea4b28 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB ``` - Rasberry Pi OS - ``` + ```bash sudo dphys-swapfile swapoff sudo nano /etc/dphys-swapfile CONF_SWAPSIZE=5120 @@ -62,14 +62,15 @@ For example if you have 8GB of RAM, then your SWAP size should be 5GB #### Prerequisites -- You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make. -- On Ubuntu: +- You will need the following dependencies to build the Conceal CLI: boost, cmake, git, gcc, g++, python, and make: ```bash sudo apt update - $ sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev + sudo apt-get install -y build-essential python-dev gcc g++ git cmake libboost-all-dev ``` - + #### Building + +- On Ubuntu: ```bash git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core @@ -99,9 +100,8 @@ Other ARM CPU/OS combinations should be possible if the CPU supports Neon/AES. #### Building -From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. - - ```bash +- From the start menu, open 'x64 Native Tools Command Prompt for vs2019' or run "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsMSBuildCmd.bat" from any command prompt. + ```ps git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core mkdir build @@ -115,17 +115,15 @@ If the build is successful the binaries will be in the `src/Release` folder. #### Prerequisites -In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. +- In order to install prerequisites, [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) needs to be installed. Once both are ready, open Terminal app and run the following command to install additional tools: - ```bash xcode-select --install ``` -On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. - -After that, proceed with installing dependencies: +- On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. +- After that, proceed with installing dependencies: ```bash brew install git python cmake gcc boost ``` @@ -133,8 +131,7 @@ After that, proceed with installing dependencies: #### Building -When all dependencies are installed, build Conceal Core binaries: - +- When all dependencies are installed, build Conceal Core binaries: ```bash git clone https://github.com/ConcealNetwork/conceal-core cd conceal-core