Readme

README.md

@@ -0,0 +1,73 @@
+# Build-script
+
+You ever just get sick and tired of having to deal with all those build systems?
+
+You know, having to type out `cmake` and `ninja` soooo much?
+
+Well this repo is for you!
+
+Probably? Maybe?
+
+This was mostly a bored at midnight project while thinking about having to make
+yet another build script, this time in powershell.
+Sort of got tired of having to deal with having 16, yes 16!, build scripts
+getting passed around for everything single project.
+Hence the creation of this. A single program to include, *or add to path*, with
+my projects that does everything *I* need.
+
+With that said, this is mostly a program I built for me and it very much expects
+how I setup cmake.
+It *should* work for most projects with a CMakeLists.txt in the root dir as long
+as a `./build/` dir doesn't already exist with needed content. But there's no promises.
+
+## Building
+
+`Precompiled releases for both windows and linux are available in the Releases
+tab. They can compile this project :3`
+
+This project uses CMake for its build system.
+Make sure you have a valid CMake version 3.28+ installation as well as a valid
+build system for cmake generated files.
+
+All needed dependences are included with the project through the use of CPM.
+All you need is cmake and compiler!
+
+### Fedora
+
+`sudo dnf install cmake g++ tbb`
+
+### Ubuntu
+
+`sudo apt install cmake g++ libtbb-dev`
+
+### Arch
+
+`sudo pacman -S cmake g++ onetbb`
+
+#### Building on Linux
+
+The normal cmake build process is all you need.
+
+1. Make the build directory `mkdir -p build`
+2. Configure the project `cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release`
+3. Build! `cmake --build build`
+
+#### Building on Windows
+
+##### With cmake-gui & Visual Studio
+
+1. Git clone the repo
+2. Run [cmake-gui](https://cmake.org/download/)
+3. Select the location you cloned the repo into as the source directory
+4. Create a new directory called 'build' in the source directory and select it
+   as the build directory
+5. Configure and generate
+6. Open the generated Visual studio project
+7. Right click the project in the project explorer and select 'build'
+
+### A note for MacOS users
+
+I do not have a MacOS system to build or test on, so building is solely up to you.
+All code has been kept as cross-platform as possible so it *should* just work,
+but if you run into any issues, feel free to submit a pull request with an updated
+codebase or readme with compilation instructions.