noah/mgen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

clarified GNU make is necessary

Browse source
This commit is contained in:
Noah Swerhun 2023-12-14 10:41:39 -06:00
parent 5582eac14f
commit 3c990e2ac7
2 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -6,8 +6,8 @@ Makefile generator for C projects.
`mgen` automatically generates build rules for all source files (extension `.c`) `mgen` automatically generates build rules for all source files (extension `.c`)
it finds in a recursive search of the directory in which it is run. It places it finds in a recursive search of the directory in which it is run. It places
the rules in your existing makefile, meaning you can easily change build options the rules in your existing GNU makefile, meaning you can easily change build
and even write your own rules based on those generated. options and even write your own rules based on those generated.
`mgen` will place the generated rules between the strings "`#=mgen_start=#`" and `mgen` will place the generated rules between the strings "`#=mgen_start=#`" and
"`#=mgen_end=#`" in your makefile. If these lines are not present, it will add "`#=mgen_end=#`" in your makefile. If these lines are not present, it will add
@ -49,7 +49,7 @@ include:
rules can use the ones generated by `mgen`, or you can just use the generated rules can use the ones generated by `mgen`, or you can just use the generated
ones; it's up to you, `mgen` gives you that option. ones; it's up to you, `mgen` gives you that option.
1. **Portability.** Once the makefile is generated, it can be run on any machine 1. **Portability.** Once the makefile is generated, it can be run on any machine
that runs `make`. Your users do not have to have `mgen` to compile your that runs GNU `make`. Your users do not have to have `mgen` to compile your
program, they can just use the generated makefile. program, they can just use the generated makefile.
## Usage ## Usage

1
src/makefile.rs
View file

@ -1,5 +1,4 @@
use std::{fs, io::ErrorKind}; use std::{fs, io::ErrorKind};
use regex::Regex; use regex::Regex;
const START_KEY: &str = "#=mgen_start=#\n"; const START_KEY: &str = "#=mgen_start=#\n";