Skip to content

Commit

Permalink
Updated README to reflect version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AvihooI committed Jul 4, 2020
1 parent c4799d5 commit 43d6699
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
Current Version: 0.3.0

Versioning System:

Major.Minor.Increment

Major: major version numbers are for significant code base changes with the exception of major version 0 that signifies early development (alpha stage) and will continue naturally into major version 1.

Minor: each development cycle gets a minor version number change.
Even numbers are for refactoring code, improving existing features, and adding internal and external documentation.
Odd numbers are for feature addition.

Increment: small changes within the current development cycle, including bug fixes and incremental planned feature additions.

Game Controls:

1) Press the enter key to pause/unpause the game, as well as start a new game on game over.
Expand All @@ -21,7 +35,7 @@ Make sure you have the appropriate DLL files in the build directory (where the e
2) SDL2_ttf.dll
3) zlib1.dll (for ttf)
4) libfreetype-6.dll (for ttf)
5) SDL2_mixer.dll and all of its
5) SDL2_mixer.dll and its relevant dependencies

Those dll files can be found in the lib directories of SDL2 and SDL2_ttf.

Expand All @@ -32,8 +46,7 @@ To build on Ubuntu Linux (and possibly other Debian distributions) with CMake:

The FindSDL2 and FindSDL2_ttf cmake modules should be able to find the dependencies with no further configurations on your part.

Running the game requires a font file called "hemi_head.ttf" - which can be found here: https://www.dafont.com/hemi-head.font.
The font has to be placed in the same folder as the executable file.
Running the game requires a few assets. You can find the assets in the latest release package.

How to contribute:

Expand All @@ -48,17 +61,19 @@ If you would like to contribute to this project, please consider the following:
Licensing:

This software is free to use, free to extend and free to commercialize with no royalty as long as acknowledgements are made to the author(s).
Assets may be copyrighted and thus should not be used in other projects (including fork projects). If you are unsure, ask.

Acknowledgements:

1) This software uses the SDL2 Library and the SDL2 True Type Font Library (by Sam Lantinga). More information can be found on the respective web pages: https://www.libsdl.org/index.php https://www.libsdl.org/projects/SDL_ttf/.
1) This software uses the SDL2 Library, the SDL2 True Type Font Library and the SDL2 Mixer Library (by Sam Lantinga). More information can be found on the respective web pages: https://www.libsdl.org/index.php https://www.libsdl.org/projects/SDL_ttf/ https://www.libsdl.org/projects/SDL_mixer/.
2) This game uses the Hemi Head True Type Font by Ray Larabie (Typodermic Fonts - https://typodermicfonts.com/).
3) This game uses sound effects found on the websites https://freesfx.co.uk/ and https://audiojungle.net/.

Planned Features:

Soon:

1) Sound effects.
1) More

Later:
1) Music
Expand All @@ -70,11 +85,15 @@ Much later, maybe:

Road Map:

Version 0.3 :
Version 0.4 (refactor & improve cycle):

1) Finish Planned Features (sound effects)
1) Code cleanup and heavy refactoring
2) Menu sounds
3) More settings in the menu
4) Minor application changes
5) Error handling and reporting

Version 0.5 :
Version 0.5 (add features cycle):

1) Export more hardcoded settings
2) Customizable color scheme
Expand Down

0 comments on commit 43d6699

Please sign in to comment.