diff options
| author | Mitja Felicijan <mitja.felicijan@gmail.com> | 2024-05-15 20:07:40 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-15 20:07:40 +0200 |
| commit | d8e012878b2685e8047f402247ca8a6002cf6526 (patch) | |
| tree | 59097220e062bcbee77ddc3ff79f953392a8e22b | |
| parent | 012f602e321e0364d236b8dd16d2b1ed4783ad7a (diff) | |
| parent | cb3ba9e72363644bf401fc2f48e74cd8809c2d54 (diff) | |
| download | makext-master.tar.gz | |
feat!: allow for script to be run of windows
| -rw-r--r-- | README.md | 28 | ||||
| -rw-r--r-- | makext.mk | 5 |
2 files changed, 23 insertions, 10 deletions
@@ -14,17 +14,17 @@ license or readme files or just testing data that is/are not needed to use it. > [!NOTE] -> This extensions are abusing GNU Make in some sense since it was not +> These extensions are abusing GNU Make in some sense since it was not > meant to really be a task runner. Keep that in mind. However, despite > that, I constantly find myself using it as such. -### Extensions +## Extensions | Extension | Description | |-------------|-----------------------------------------------------| -| help | Displays all targets with a comment in help format. | -| assure | Check for the existence of programs on a machine. | -| environment | Loads environmental variables from other files. | +| **help** | Displays all targets with a comment in help format. | +| **assure** | Check for the existence of programs on a machine. | +| **environment** | Loads environmental variables from other files. | Additional features: @@ -35,12 +35,17 @@ Tested on: - GNU Linux Debian 12 with GNU Make 4.3 - macOS Sonoma 14.4.1 with GNU Make 3.81 +- Windows 10/11 with GNU Make 4.4.1 for Windows32 If you have an idea for a new feature [open a new issue](https://github.com/mitjafelicijan/makext/issues/new). ## How to use +> [!IMPORTANT] +> If you intend to use this script on Windows machine +> make sure you have all the [prerequisites](#windows-specific-instructions) installed. + First you will need to download `makext.mk` file from the repository to the same directory where you have `Makefile`. @@ -61,6 +66,19 @@ help: .help > targets in your `Makefile`. GNU Make will execute first target if > no target provided as an argument when calling `make`. +### Windows specific instructions + +On Windows OS'es you need the following: + +- Git Bash for Windows +- make + +All of the above can be conveniently installed via [Scoop](https://scoop.sh/): + +```sh +scoop install main/git main/make +``` + ## Help extension One of the extensions is `.help` which displays all the targets in the @@ -10,11 +10,6 @@ # `makext` was written by Mitja Felicijan and is released under the BSD # two-clause license, see the LICENSE file for more information. -# Checks if operating system is Windows and exists with error. -ifeq ($(OS),Windows_NT) -$(error makext does not support Windows operating system) -endif - # Load environmental files from `MEX_ENVIRONMENT`. By default GNU make # loads what is already in `env`. This extends it to other files. ifdef MEX_ENVIRONMENT |