add readme
This commit is contained in:
parent
1be9ff544c
commit
9435e17d7d
3 changed files with 15 additions and 0 deletions
1
Makefile
1
Makefile
|
@ -10,3 +10,4 @@ bear: clean
|
||||||
clean:
|
clean:
|
||||||
$(MAKE) -C src clean
|
$(MAKE) -C src clean
|
||||||
$(MAKE) -C test clean
|
$(MAKE) -C test clean
|
||||||
|
rm -rf compile_commands.txt
|
||||||
|
|
14
README.md
Normal file
14
README.md
Normal 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.
|
BIN
src/libgearlib.a
BIN
src/libgearlib.a
Binary file not shown.
Loading…
Add table
Reference in a new issue