From 53b5b9388c7b6134818dae28893785e534401e5d Mon Sep 17 00:00:00 2001 From: Jacek Sieka Date: Tue, 4 Sep 2018 23:05:11 -0600 Subject: [PATCH] ci: update readme: fix license, badges --- .appveyor.yml | 109 ++++++++++++++++++++++++------------ .travis.yml | 25 +++++++-- LICENSE => LICENSE-APACHEv2 | 0 LICENSE-MIT | 21 +++++++ README.md | 11 +++- 5 files changed, 125 insertions(+), 41 deletions(-) rename LICENSE => LICENSE-APACHEv2 (100%) create mode 100644 LICENSE-MIT diff --git a/.appveyor.yml b/.appveyor.yml index 7c34169..622ad58 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -1,48 +1,87 @@ version: '{build}' cache: -- nim-0.18.0_x64.zip -- x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z -- i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z -- packages -> **\packages.config -- '%LocalAppData%\NuGet\Cache -> **\packages.config' +- x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z -> .appveyor.yml +- i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z -> .appveyor.yml +- Nim -> .appveyor.yml matrix: - fast_finish: true + # We always want 32 and 64-bit compilation + fast_finish: false -environment: - matrix: - - MINGW_ARCHIVE: x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z - MINGW_DIR: mingw64 - # We need to hardcode a mirror otherwise the download fails - MINGW_URL: https://ayera.dl.sourceforge.net/project/mingw-w64/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/4.9.2/threads-win32/seh/x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z - NIM_ARCHIVE: nim-0.18.0_x64.zip - NIM_DIR: nim-0.18.0 - NIM_URL: https://nim-lang.org/download/nim-0.18.0_x64.zip - platform: x64 - - MINGW_ARCHIVE: i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z - MINGW_DIR: mingw32 - # We need to hardcode a mirror otherwise the download fails - MINGW_URL: https://netcologne.dl.sourceforge.net/project/mingw-w64/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/4.9.2/threads-win32/dwarf/i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z - NIM_ARCHIVE: nim-0.18.0_x64.zip - NIM_DIR: nim-0.18.0 - NIM_URL: https://nim-lang.org/download/nim-0.18.0_x32.zip - platform: x86 +platform: + - x86 + - x64 install: - - MKDIR %CD%\tools_tmp - - IF not exist "%MINGW_ARCHIVE%" appveyor DownloadFile "%MINGW_URL%" -FileName "%MINGW_ARCHIVE%" - - 7z x -y "%MINGW_ARCHIVE%" -o"%CD%\tools_tmp"> nul - - IF not exist "%NIM_ARCHIVE%" appveyor DownloadFile "%NIM_URL%" -FileName "%NIM_ARCHIVE%" - - 7z x -y "%NIM_ARCHIVE%" -o"%CD%\tools_tmp"> nul - - SET PATH=%CD%\tools_tmp\%NIM_DIR%\bin;%CD%\tools_tmp\%MINGW_DIR%\bin;%PATH% - - SET PATH=%PATH%;%CD% + - setlocal EnableExtensions EnableDelayedExpansion + + - IF "%PLATFORM%" == "x86" ( + SET "MINGW_ARCHIVE=i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z" & + SET "MINGW_URL=https://sourceforge.net/projects/mingw-w64/files/Toolchains%%20targetting%%20Win32/Personal%%20Builds/mingw-builds/4.9.2/threads-win32/dwarf/i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z" & + SET "MINGW_DIR=mingw32" + ) ELSE ( + IF "%PLATFORM%" == "x64" ( + SET "MINGW_ARCHIVE=x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z" & + SET "MINGW_URL=https://sourceforge.net/projects/mingw-w64/files/Toolchains%%20targetting%%20Win64/Personal%%20Builds/mingw-builds/4.9.2/threads-win32/seh/x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z" & + SET "MINGW_DIR=mingw64" + ) else ( + echo "Unknown platform" + ) + ) + + - SET PATH=%CD%\%MINGW_DIR%\bin;%CD%\Nim\bin;%PATH% + + # Unpack mingw + - IF NOT EXIST "%MINGW_ARCHIVE%" appveyor DownloadFile "%MINGW_URL%" -FileName "%MINGW_ARCHIVE%" + - 7z x -y "%MINGW_ARCHIVE%" > nul + + # build nim from our own branch - this to avoid the day-to-day churn and + # regressions of the fast-paced Nim development while maintaining the + # flexibility to apply patches + - SET "NEED_REBUILD=" + + - IF NOT EXIST "Nim\\.git\\" ( + git clone https://github.com/status-im/Nim.git + ) ELSE ( + ( cd Nim ) & + ( git pull ) & + ( cd .. ) + ) + + # Rebuild Nim if HEAD has moved or if we don't yet have a cached version + - IF NOT EXIST "Nim\\ver.txt" ( + SET NEED_REBUILD=1 + ) ELSE ( + ( CD Nim ) & + ( git rev-parse HEAD > ..\\cur_ver.txt ) & + ( fc ver.txt ..\\cur_ver.txt > nul ) & + ( IF NOT ERRORLEVEL == 0 SET NEED_REBUILD=1 ) & + ( cd .. ) + ) + + - IF NOT EXIST "Nim\\bin\\nim.exe" SET NEED_REBUILD=1 + - IF NOT EXIST "Nim\\bin\\nimble.exe" SET NEED_REBUILD=1 + + # after building nim, wipe csources to save on cache space + - IF DEFINED NEED_REBUILD ( + cd Nim & + ( IF EXIST "csources" rmdir /s /q csources ) & + git clone --depth 1 https://github.com/nim-lang/csources & + cd csources & + ( IF "%PLATFORM%" == "x64" ( build64.bat ) else ( build.bat ) ) & + cd .. & + bin\nim c koch & + koch boot -d:release & + koch nimble & + git rev-parse HEAD > ver.txt & + rmdir /s /q csources + ) build_script: - - nimble.exe refresh - + - cd C:\projects\%APPVEYOR_PROJECT_SLUG% + - nimble install -y test_script: - - git submodule update --init --recursive - - nimble.exe test + - nimble test deploy: off diff --git a/.travis.yml b/.travis.yml index 6e9f328..8e56f7e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,9 @@ language: c # or other C/C++ variants sudo: false # https://docs.travis-ci.com/user/caching/ +# +# Caching the whole nim folder is better than relying on ccache - this way, we +# skip the expensive bootstrap process and linking cache: directories: - nim @@ -12,11 +15,25 @@ os: - osx install: - # build nim from our own branch, to avoid downtime due to nim regressions + # build nim from our own branch - this to avoid the day-to-day churn and + # regressions of the fast-paced Nim development while maintaining the + # flexibility to apply patches + # + # check version of remote branch - "export NIMVER=$(git ls-remote https://github.com/status-im/nim.git HEAD | cut -f 1)" - - "{ [ -f nim/$NIMVER/bin/nim ] && [ -f nim/$NIMVER/bin/nimble ] ; } || { rm -rf nim ; mkdir -p nim; git clone https://github.com/status-im/nim.git nim/$NIMVER; cd nim/$NIMVER; sh build_all.sh; cd ../.. ; }" + + # after building nim, wipe csources to save on cache space + - "{ [ -f nim/$NIMVER/bin/nim ] && [ -f nim/$NIMVER/bin/nimble ] ; } || + { rm -rf nim ; + mkdir -p nim ; + git clone --depth=1 https://github.com/status-im/nim.git nim/$NIMVER ; + cd nim/$NIMVER ; + sh build_all.sh ; + rm -rf csources ; + cd ../.. ; + }" - "export PATH=$PWD/nim/$NIMVER/bin:$PATH" script: - - nimble install -dy && nimble test - + - nimble install -y + - nimble test diff --git a/LICENSE b/LICENSE-APACHEv2 similarity index 100% rename from LICENSE rename to LICENSE-APACHEv2 diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8766e65 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Status Research & Development GmbH + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index b24081b..91950ec 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -**nim-secp256k1** +# secp256k1 [![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-secp256k1/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-secp256k1) -[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/jarradh/nim-secp256k1/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/jarradh/nim-secp256k1) +[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-secp256k1/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-secp256k1) [![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg) # Introduction This library is a wrapper for Bitcoin's [secp256k1](https://github.com/bitcoin-core/secp256k1) library. @@ -21,4 +23,9 @@ requires "secp256k1" git submodule update --init nimble test ``` +## License +Licensed under both of the following: + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT