add readme

This commit is contained in:
sam 2024-08-11 16:26:37 +12:00
parent 1be9ff544c
commit 9435e17d7d
3 changed files with 15 additions and 0 deletions

View file

@ -10,3 +10,4 @@ bear: clean
clean:
$(MAKE) -C src clean
$(MAKE) -C test clean
rm -rf compile_commands.txt

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# Gearlib Rewrite
This is a rewrite of gearlib to make it easier to use, as the previous version was written when I wasn't great at writing libraries for C.
## Dependencies
- glfw3 (Needs to be installed to your system)
- pkg-config (Used for finding libraries such as glfw3)
## Building
1. Clone the repo: ```git clone https://git.samahh.dev/sam/gearlib-rw --recursive```
2. Move into the cloned directory: ```cd gearlib-rw```
3. Run: `sudo make install`
## Usage
Compile your projects with ```-lgearlib```, for code examples check the examples directory.

Binary file not shown.