From 4dbf5da63842259572ed9410a9366bf8f69a6067 Mon Sep 17 00:00:00 2001 From: Vishal Pankaj Chandratreya <19171016+tfpf@users.noreply.github.com> Date: Sat, 30 Sep 2023 14:44:14 +0530 Subject: [PATCH 1/2] Workflows cleaned and renamed appropriately. Benchmarking is unnecessary in GitHub Actions. --- .github/workflows/{build-windows.yml => cygwin.yml} | 6 ++---- .github/workflows/{build-unix.yml => unix.yml} | 4 +--- README.md | 10 ++++++++-- 3 files changed, 11 insertions(+), 9 deletions(-) rename .github/workflows/{build-windows.yml => cygwin.yml} (81%) rename .github/workflows/{build-unix.yml => unix.yml} (84%) diff --git a/.github/workflows/build-windows.yml b/.github/workflows/cygwin.yml similarity index 81% rename from .github/workflows/build-windows.yml rename to .github/workflows/cygwin.yml index 47df868..2285d97 100644 --- a/.github/workflows/build-windows.yml +++ b/.github/workflows/cygwin.yml @@ -1,4 +1,4 @@ -name: build-windows +name: cygwin on: [push, workflow_dispatch] defaults: run: @@ -18,10 +18,9 @@ jobs: - uses: actions/checkout@v4 - uses: cygwin/cygwin-install-action@v4 with: - packages: cmake gcc-core gcc-g++ make pkg-config + packages: cmake gcc-core make pkg-config - run: ./run.sh - run: cd tests && make && ./tests - - run: cd benchmarks && make && ./benchmarks python: name: windows-2022 / Python runs-on: windows-2022 @@ -32,4 +31,3 @@ jobs: packages: gcc-core python3 python3-devel python3-pip - run: python3 -m pip install . - run: python3 examples/Python/thread-safe.py - - run: python3 benchmarks/benchmarks.py diff --git a/.github/workflows/build-unix.yml b/.github/workflows/unix.yml similarity index 84% rename from .github/workflows/build-unix.yml rename to .github/workflows/unix.yml index 2cbc565..7f45a0d 100644 --- a/.github/workflows/build-unix.yml +++ b/.github/workflows/unix.yml @@ -1,4 +1,4 @@ -name: build-unix +name: unix on: [push, workflow_dispatch] env: LD_LIBRARY_PATH: /usr/local/lib @@ -15,7 +15,6 @@ jobs: - uses: actions/checkout@v4 - run: ./run.sh - run: cd tests && make && ./tests - - run: cd benchmarks && make && ./benchmarks python: name: ${{ matrix.os }} / Python runs-on: ${{ matrix.os }} @@ -26,4 +25,3 @@ jobs: - uses: actions/checkout@v4 - run: python3 -m pip install . - run: python3 examples/Python/thread-safe.py - - run: python3 benchmarks/benchmarks.py diff --git a/README.md b/README.md index 49d172f..ae424ff 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,14 @@ On Windows, these are available natively via [MSYS2](https://www.msys2.org) (not [Homebrew](https://brew.sh); however, their Apple-specific variants provided by [Xcode](https://apps.apple.com/app/xcode/id497799835) should also be fine. -![build-unix](https://github.com/tfpf/hash-drbg/actions/workflows/build-unix.yml/badge.svg) -![build-windows](https://github.com/tfpf/hash-drbg/actions/workflows/build-windows.yml/badge.svg) +## Troubleshooting Information +Installing directly on Windows is a massive headache. MSVC adds some unnecessary flags which are incompatible with +optimisation flags, so the program does not compile. Its concurrency library doesn't properly implement atomic data +types, and isn't standard-compliant. Further, Windows does not provide a random device. That is why I suggest MSYS2 and +Cygwin. If installation fails for you, check the [workflows](.github/workflows) to see how I got it working. + +![unix](https://github.com/tfpf/hash-drbg/actions/workflows/unix.yml/badge.svg) +![cygwin](https://github.com/tfpf/hash-drbg/actions/workflows/cygwin.yml/badge.svg) ## Install for C (and C++) ```shell From 10fa2ec205782f620299699cb51da03196aa7ff1 Mon Sep 17 00:00:00 2001 From: Vishal Pankaj Chandratreya <19171016+tfpf@users.noreply.github.com> Date: Sat, 30 Sep 2023 14:51:44 +0530 Subject: [PATCH 2/2] Alphabetical order! --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae424ff..fed7e1b 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,8 @@ optimisation flags, so the program does not compile. Its concurrency library doe types, and isn't standard-compliant. Further, Windows does not provide a random device. That is why I suggest MSYS2 and Cygwin. If installation fails for you, check the [workflows](.github/workflows) to see how I got it working. -![unix](https://github.com/tfpf/hash-drbg/actions/workflows/unix.yml/badge.svg) ![cygwin](https://github.com/tfpf/hash-drbg/actions/workflows/cygwin.yml/badge.svg) +![unix](https://github.com/tfpf/hash-drbg/actions/workflows/unix.yml/badge.svg) ## Install for C (and C++) ```shell