diff options
| author | hachem <im@hachem.wtf> | 2026-09-18 19:41:30 +0200 |
|---|---|---|
| committer | hachem <im@hachem.wtf> | 2026-09-18 19:41:30 +0200 |
| commit | 0c4716968a6ad336324af15df158db66db3f651f (patch) | |
| tree | 5a961d58d8c19cf5df8852ebf3c43a30aa9eac1c | |
| parent | 65b73b420b5eadc6f10e732f6536430ec85011a4 (diff) | |
chore: update README
| -rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -1,19 +1,19 @@ # mkproj -Just a dumb bullshit utility that generates build system boilerplate and gets the fuck out of your way. +just a dumb bullshit utility that generates build system boilerplate and gets the fuck out of your way. -Like, imagine you want to start a new project. Maybe it's something scalable, maybe it's just some stupid scratch program to test an idea. Either way, before you've written a single line of the thing you actually want to make, you have to pick a build system, because project management in C is fucking cancer. Then you have to go out of your way to write a `Makefile`, or a `CMakeLists.txt`, or whatever other configuration file your build system decided it needed, instead of just actually writing whatever the fuck it is you wanted to write. +like, imagine you want to start a new project. maybe it's something scalable, maybe it's just some stupid scratch program to test an idea. either way, before you've written a single line of the thing you actually want to make, you have to pick a build system, because project management in c is fucking cancer. then you have to go out of your way to write a `Makefile`, or a `CMakeLists.txt`, or whatever other configuration file your build system decided it needed, instead of just actually writing whatever the fuck it is you wanted to write. -`mkproj` fixes that. It makes a directory, generates the boilerplate for the build system you picked — currently `make`, `cmake`, `meson`, and `premake` — and that's it. You get a project you can immediately build, and you never use `mkproj` again. +`mkproj` fixes that. it makes a directory, generates the boilerplate for the build system you picked — currently `make`, `cmake`, `meson`, and `premake` — and that's it. you get a project you can immediately build, and you never use `mkproj` again. -There are a couple of things you can customize: whether it initializes a git repository, the language (`c`, `cpp`, or, god forbid, `objc`), the language standard, where your build output goes, and whether you want a separate intermediate directory for object files. But most of the time, you shouldn't have to think about any of that. +there are a couple of things you can customize: whether it initializes a git repository, the language (`c`, `cpp`, or, god forbid, `objc`), the language standard, where your build output goes, and whether you want a separate intermediate directory for object files. but most of the time, you shouldn't have to think about any of that. ```sh $ mkproj hello ``` -That's a C project using `make`. `cd hello && make` and you're off. +that's a c project using `make`. `cd hello && make` and you're off. -## Usage +## usage ```text $ mkproj --help mkproj 0.3.0 - dumb project generator @@ -48,21 +48,21 @@ $ mkproj -b make --bin-int obj tool # objects in obj/, binary in bin/ $ mkproj --no-git scratch # don't bother with git ``` -## Build +## build -Needs a C compiler. Nothing else. +needs a c compiler. nothing else. ```sh $ sudo make install # -> /usr/local/bin + man page $ make install PREFIX=~/.local # or somewhere without sudo ``` -It really is one file, so if you don't want the Makefile: +it really is one file, so if you don't want the makefile: ```sh $ cc -O2 mkproj.c -o mkproj ``` -## License +## license -`mkproj` is licensed under the MIT License. See [LICENSE](LICENSE) for more. +`mkproj` is licensed under the mit license. see [license](LICENSE) for more. |
