Skip to content

Commit

Permalink
Readme updated for new GH actions / minor build warning fix
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchcapper committed Aug 11, 2023
1 parent f8d3794 commit 087cea0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/restore_deps_to_cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ jobs:
workflow: tool_${{ steps.vars.outputs.Dep7Name }}_build.yml

- name: Save Cache
if: steps.cachecheck.outputs.cache-hit != 'true'
# make sure we have at least one item to cache
if: ${{ steps.vars.outputs.Dep1Name && steps.cachecheck.outputs.cache-hit != 'true' }}
uses: actions/cache/save@v3
with:
path: |
Expand Down
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[![Tool Builds](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_builds.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_builds.yml) | [![GNULIB Patch Tests](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/gnulib_tests.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/gnulib_tests.yml)


<!-- MarkdownTOC -->

- [Current Tools](#current-tools)
- [What is it?](#what-is-it)
- [Warnings](#warnings)
- [Why](#why)
Expand All @@ -20,19 +21,49 @@

<!-- /MarkdownTOC -->

# Current Tools
| Our Changes | CI Action Status |
| :---: | :---: |
| [gnulib](repo_notes/gnulib_README.md) | [![GNULIB Patch Tests](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/gnulib_tests.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/gnulib_tests.yml) |
| [automake](repo_notes/automake_README.md) | [![automake Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_automake_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_automake_build.yml) |
| [awk](repo_notes/awk_README.md) | [![awk Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_awk_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_awk_build.yml) |
| [coreutils](repo_notes/coreutils_README.md) | [![coreutils Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_coreutils_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_coreutils_build.yml) |
| [diffutils](repo_notes/diffutils_README.md) | [![diffutils Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_diffutils_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_diffutils_build.yml) |
| [findutils](repo_notes/findutils_README.md) | [![findutils Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_findutils_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_findutils_build.yml) |
| [gawk](repo_notes/gawk_README.md) | [![gawk Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_gawk_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_gawk_build.yml) |
| [grep](repo_notes/grep_README.md) | [![grep Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_grep_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_grep_build.yml) |
| [gzip](repo_notes/gzip_README.md) | [![gzip Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_gzip_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_gzip_build.yml) |
| [highlight](repo_notes/highlight_README.md) | [![highlight Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_highlight_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_highlight_build.yml) |
| [libhsts](repo_notes/hsts_README.md) | [![libhsts Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_libhsts_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_libhsts_build.yml) |
| [make](repo_notes/make_README.md) | [![make Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_make_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_make_build.yml) |
| [openssl](repo_notes/openssl_README.md) | [![openssl Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_openssl_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_openssl_build.yml) |
| [patch](repo_notes/patch_README.md) | [![patch Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_patch_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_patch_build.yml) |
| [pcre2](repo_notes/pcre2_README.md) | [![pcre2 Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_pcre2_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_pcre2_build.yml) |
| [pdcurses](repo_notes/pdcurses.md) | [![pdcurses Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_pdcurses_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_pdcurses_build.yml) |
| [sed](repo_notes/sed_README.md) | [![sed Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_sed_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_sed_build.yml) |
| [symlinks](repo_notes/symlinks_README.md) | [![symlinks Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_symlinks_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_symlinks_build.yml) |
| [tar](repo_notes/tar_README.md) | [![tar Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_tar_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_tar_build.yml) |
| [wget2](repo_notes/wget2_README.md) | [![wget2 Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wget2_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wget2_build.yml) |
| [wget](repo_notes/wget_README.md) | [![wget Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wget_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wget_build.yml) |
| [which](repo_notes/which_README.md) | [![which Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_which_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_which_build.yml) |
| [wolfCrypt](repo_notes/wolfcrypt_README.md) | [![wolfCrypt Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wolfcrypt_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_wolfcrypt_build.yml) |
| [zlib](repo_notes/zlib_README.md) | [![zlib Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_zlib_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_zlib_build.yml) |
| [zstd](repo_notes/zstd_README.md) | [![zstd Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_zstd_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_zstd_build.yml) |
| WIP: [bash](repo_notes/bash_README.md) | [![bash Build](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_bash_build.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_bash_build.yml) |

# What is it?

It is a few primary components:

- This is a set of patches, mostly for [gnulib](repo_notes/gnulib_README.md), to increase compatibility with windows systems.
- A common bash script helper (helpers*.sh) and short template file for easily compiling gnulib and non-gnulib linux apps. The focus is on moving as much duplicate code to the helper includes rather than in each build script. This includes several debug/trace tools and make/cmake/nmake wrappers.
- A bash script that uses the above helper lib to compile a variety of common *nix tools for details on changes for each: [tar](repo_notes/tar_README.md), [grep](repo_notes/grep_README.md), [gzip](repo_notes/gzip_README.md), [pcre2](repo_notes/pcre2_README.md), [zstd](repo_notes/zstd_README.md), [coreutils](repo_notes/coreutils_README.md), [findutils](repo_notes/findutils_README.md), [diffutils](repo_notes/diffutils_README.md), [which](repo_notes/which_README.md), [sed](repo_notes/sed_README.md), [openssl](repo_notes/openssl_README.md), [wget](repo_notes/wget_README.md), [highlight](repo_notes/highlight_README.md), [patch](repo_notes/patch_README.md), [make](repo_notes/make_README.md), [automake](repo_notes/automake_README.md), [symlinks](repo_notes/symlinks_README.md), [wget2](repo_notes/wget2_README.md), [pdcurses](repo_notes/pdcurses.md), [libhsts](repo_notes/hsts_README.md), [wolfCrypt](repo_notes/wolfcrypt_README.md), [awk](repo_notes/awk_README.md), [gawk](repo_notes/gawk_README.md), [zlib](repo_notes/zlib_README.md). Also, WIP: [bash](repo_notes/bash_README.md).
- A bash script that uses the above helper lib to compile a variety of common *nix tools for details on changes for each use the link in the list above.
- A tool to generate a basic Visual Studio debug project to debug the target, if you can't run the binary in the debugger you can add `launchdebugger()` to the code run from the CLI and will get the normal JIT prompt. Note due to how the debugger launch works it may better to do a bit earlier than needed (or in the main launch). If the code you want to debug into is part of a library then you need to remove that code from the library (and add to your MSVC project) or build that library in MSVC. The VS project comes with `debug.h` and `debug.c` that includes a basic console/file logger.
- Easy build flags to compile debug versions of all the libraries and the project itself with MSVC edit and continue support (without needing them all in a VS project)
- Minimal changes to each target to make it work, to reduce maintenance requirements as the code changes. For some of these projects we throw additional gnulib modules at it that seem to fix the problems, there may be easier ways but this does result in minimal changes to the native code base.
- Build entire projects in Windows native debug mode for full VS debugging and symbols
- Logging of build process to create a batch file (.bat) to be able to build most projects without any subsystem at all
- Github actions produces **Windows binaries** for download. You can find these under the [![Tool Builds](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_builds.yml/badge.svg)](https://github.com/mitchcapper/WIN64LinuxBuild/actions/workflows/tool_builds.yml) workflows, click on a successful one and then the downloads can be found under Artifacts on that page. Note: you must be signed into github to see the artifacts produced.
- Github actions produces **Windows binaries** for download. You can find these under the workflow links in the list above, click on a successful one and then the downloads can be found under Artifacts on that page. Note: you must be signed into github to see the artifacts produced.

# Warnings

Expand Down

0 comments on commit 087cea0

Please sign in to comment.