diff --git a/README.md b/README.md index cdbaf587..465da349 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,50 @@ -This base is really shit and contains a lot of shit code as a result of being me, Shane, and Anshul's first C++ project. Thank you for everyone who has joined me and my friends on this journey, it has been great! Maybe the readme will be updated in the future. Pull requests are welcomed. +### Prerequisites: +1. **CMake**: Ensure CMake is installed on your system. You can download it from [cmake.org](https://cmake.org/download/) and follow the installation instructions for your operating system. -Make sure to read the license terms before modifying or distributing, though i don't really care, shame on you if you skid from this shitass base +2. **Git**: Install Git if you haven't already. You can download Git from [git-scm.com](https://git-scm.com/downloads) and follow the installation instructions. -Building the DLL should be easy. Just clone, set up your IDE and make sure you have the necessary tools ready to build with CMAKE, watch a tutorial or two if you don't know and there you have it. In theory, debug and release builds both should work. +### Steps to Clone and Build the Project: + +1. **Clone the Repository**: + Open a terminal or command prompt and clone the repository using Git: + ```bash + git clone https://github.com/flarialmc/dll.git + ``` + +2. **Navigate to the Project Directory**: + Change into the directory of the cloned repository: + ```bash + cd dll + ``` + +3. **Create a Build Directory**: + It's a good practice to create a separate directory for out-of-source builds. This keeps your source directory clean and allows for easier management of builds: + ```bash + mkdir build + cd build + ``` + +4. **Configure with CMake**: + Run CMake to configure the build environment. Specify the path to the CMakeLists.txt file in the root of the cloned repository: + ```bash + cmake .. + ``` + This command generates the necessary build files based on the CMake configuration. + +5. **Build the Project**: + Once CMake has configured the build files successfully, you can build the project using a suitable build tool (like `make` on Unix-like systems or Visual Studio on Windows): + ```bash + cmake --build . + ``` + This command compiles the project according to the generated build files. + +### Additional Notes: +- **Dependencies**: If the project has external dependencies that are not included in the repository, ensure they are installed on your system before running CMake. You may need to specify their paths or use CMake options (`-D` flags) to configure the project correctly. + +- **Build Configurations**: CMake supports different build configurations (e.g., Debug, Release). You can specify these configurations during the CMake configuration step using `-DCMAKE_BUILD_TYPE`: + ```bash + cmake -DCMAKE_BUILD_TYPE=Release .. + ``` + Replace `Release` with `Debug` or any other configuration you need. + +By following these steps, you should be able to clone and build the project using CMake successfully.