sumptum/PPrinciples2017
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Edited readme

Browse Source
This commit is contained in:
Joe Adams 2017-12-07 14:20:11 +00:00
parent 70ff7e3386
commit 74b15c7b7b
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
readme.md
View File

@ -25,7 +25,7 @@ and CentOS/Fedora:
> \# yum install clang > \# yum install clang
#### SDL #### SDL
*Simple DirectMedia Layer library* *Simple DirectMedia Layer library*
See the [SDL wiki page](https://wiki.libsdl.org/Installation) for installation instructions See the [SDL wiki page](https://wiki.libsdl.org/Installation) for installation instructions
### Installing ### Installing
@ -36,10 +36,9 @@ Clone the repository (into a new directory *breakout_dir*)
#### Breakout #### Breakout
Change to the breakout directory inside the repository (contains the main program) Change to the breakout directory inside the repository (contains the main program) and run `make` to compile
and run `make` to compile
> $ cd breakout_dir/breakout > $ cd breakout_dir/breakout
> $ make > $ make
To run, execute the output binary - **breakout** (takes no args) To run, execute the output binary - **breakout** (takes no args)
@ -48,7 +47,7 @@ To run, execute the output binary - **breakout** (takes no args)
##### Troubleshooting ##### Troubleshooting
**Permission denied:** Usually this is a result of the binary not having the correct permission bits set. **Permission denied:** Usually this is a result of the binary not having the correct permission bits set.
The user must have permission to execute the binary, e.g. The user must have permission to execute the binary, e.g.
> $ chmod +x ./breakout > $ chmod +x ./breakout
@ -66,10 +65,10 @@ Stderr may contain more information. See source for more
#### (Others) #### (Others)
Other folders contain test and reference code, detailed below. Other folders contain test and reference code, detailed below.
For build instructions, view the readme files provided within For build instructions, view the readme files provided within
Running `make` with no arguments will prompt, e.g.: Running `make` with no arguments will prompt, e.g.:
> $ cd breakout_dir/sdlboilerplate > $ cd breakout_dir/sdlboilerplate
> $ make > $ make
@ -85,7 +84,7 @@ This is the main folder for the project, containing the code for the breakout ga
#### (Others) #### (Others)
Additional subfolders contain reference, experimental or tangential code used in creating neccesary components of the program. Additional subfolders contain reference, experimental or tangential code used in creating neccesary components of the program.
For credits and usage details, see the readme files provided within For credits and usage details, see the readme files provided within
### Authors ### Authors