From e1e13ca0cd90ac30c27d90df841bfa7469afbf37 Mon Sep 17 00:00:00 2001 From: fromelicks <108532072+fromelicks@users.noreply.github.com> Date: Wed, 15 May 2024 17:28:47 +0200 Subject: feat!: allow for script to be run of windows Removed Windows panicking check in `makext.mk`. Updated README.md with instructions to run on Windows. --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 967a406..29cf802 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ 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 +> This 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 | |-------------|-----------------------------------------------------| @@ -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 -- cgit v1.2.3 From 83539cee1e52b039565b145d5de34e6492332c29 Mon Sep 17 00:00:00 2001 From: fromelicks <108532072+fromelicks@users.noreply.github.com> Date: Wed, 15 May 2024 17:33:27 +0200 Subject: fix(readme): typo --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 29cf802..5098c29 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ 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. @@ -22,9 +22,9 @@ use it. | 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: -- cgit v1.2.3 From cb3ba9e72363644bf401fc2f48e74cd8809c2d54 Mon Sep 17 00:00:00 2001 From: fromelicks <108532072+fromelicks@users.noreply.github.com> Date: Wed, 15 May 2024 18:02:34 +0200 Subject: fix(readme): broken link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5098c29..7228a6a 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ issue](https://github.com/mitjafelicijan/makext/issues/new). > [!IMPORTANT] > If you intend to use this script on Windows machine -> make sure you have all the [prerequisites](###windows-specific-instructions) installed. +> 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`. -- cgit v1.2.3