Update readme.md

This commit is contained in:
Joseph Aquino 2026-04-14 06:41:07 +00:00
parent 3ec9d185b5
commit 1b701100ef
1 changed files with 19 additions and 0 deletions

View File

@ -1 +1,20 @@
# A small command line app that mimics some of the basic internal commands of git
## Build instructions
### Requirements
* CMake
* On Windows: Visual Studio 2022 or newer
* On Linux: Make, GCC/Clang
### Linux
* Navigate to project root
* Configure Cmake project
<br>```cmake -B build```
* Build Cmake project
<br>```cmake --build build```
* The executible will be in the 'bin' folder
### Windows
* Run the 'generate-solution.bat' file
* Open the Visual Studio solution file that is in the newly created 'build' folder
* Use Visual Studio to build the project
<a href="https://www.flaticon.com/free-icons/version-control" title="version control icons">Version control icons created by See Icons - Flaticon</a> <a href="https://www.flaticon.com/free-icons/version-control" title="version control icons">Version control icons created by See Icons - Flaticon</a>