diff --git a/README.md b/README.md index 45f0219..0859464 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,9 @@ This is my exam practise for the upcoming C++ examination that falls on the 16th The files here will be split up from `*.cpp` source files, `*.md` documentation files and a Makefile. -This is just how I have files and the Makefile because I'm a lazy shit. +This is just how I have files and the [Makefile](makefile_tutorial.md) because I'm a lazy shit. ## Notice -When attempting to use the Makefile, I have configured it so that you must use arguments to use it. -Below is an example of compiling it: - -```bash -make build file="macros.cpp" # assuming you want to compile this file -``` -For me, it just saves time. - - -## Double notice I hate C++ with a burning passion. It's not for me, but it's a skill I will now hold for the rest of the time I exist. ~~Defo not ever using GPT for this shit.~~ ###### Made by [Taran Nagra](https://github.coventry.ac.uk/nagrat) \ No newline at end of file diff --git a/makefile_tutorial.md b/makefile_tutorial.md new file mode 100644 index 0000000..4f3dbc2 --- /dev/null +++ b/makefile_tutorial.md @@ -0,0 +1,26 @@ +# My Makefile usage + +I have a [Makefile](Makefile), it's usage is quite simple. I made it because it's easier for me to compile without having to type out the entire god damn command. Even though that's fun for me. Don't @ me, I know it's weird; like my love for OOP. + +## Usage +It has 3 commands for automation and can be added to have more if needed. For my needs, 3 is enough. + +### Build +```bash +make build "filename.cpp" # makes file - dependent on platform may be exe or not +``` +The filename has to be the "" or it will not count it as an argument. + +### Build and run... and clear +```bash +make runb "filename.cpp" +``` +This makes and runs the file assuming it's called file.exe, if not, manually change it in the Makefile. + +### Clean +```bash +make clean # removes *.exe +``` +This removes all .exe files for Windows. + +#### Made by [Taran Nagra](https://github.coventry.ac.uk/nagrat) \ No newline at end of file