Skip to content

Commit

Permalink
oops forgot readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bee Bussell committed Sep 8, 2021
1 parent b8ddaef commit f752867
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# bSDL
# BML

bSDL is the SDL wrapper that BlueKit2D will use. It is designed to handle many of the lower level task for the engine and keep them obstructed so that I can focus more on the structure of components and data when creating the engine.
BML is the SDL wrapper that BlueKit2D will use. It is designed to handle many of the lower level task for the engine and keep them obstructed so that I can focus more on the structure of components and data when creating the engine.

### Uses
This project is mostly for personal use so I do not plan on writing much in-depth documentation on how it works other than my personal comments I leave for myself. Just like ask me if you want to know how something works but really I am trying to keep it as straight forward as possible

### Build Instructions
Install SDL2 and SDL_Image to run follow instructions based off your os for this.
Install SDL2, SDL_Image, and SDL_Mixer following instructions based off your OSs for this.
Once you have done that you can copy this code into your terminal of choice

```
git clone [email protected]:BSBussell/bSDL.git
cd bSDL
make bSDL
git clone [email protected]:BSBussell/BML.git
cd BML
make BML
```

This will create the linker objects to use when compiling with your program.
Expand Down

0 comments on commit f752867

Please sign in to comment.