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 }} diff --git a/README.md b/README.md index 1cba2e04..b3ea4b28 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. @@ -59,20 +62,22 @@ 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 ``` - + #### Building -- `git clone https://github.com/ConcealNetwork/conceal-core` -- `cd conceal-core` -- `mkdir build && cd $_` -- `cmake ..` -- `make` +- On Ubuntu: + ```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. @@ -95,15 +100,14 @@ 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 -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 -``` +- 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 + 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. @@ -111,34 +115,32 @@ 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 + ``` -```bash -$ xcode-select --install -``` - -On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. +- On newer macOS versions (v10.14 and higher) this step is done through Software Update in System Preferences. -After that, proceed with installing dependencies: +- 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 -``` +- 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 + ``` 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.