gunghogeoduck/Electric
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md with more proper markdown

Browse source
This commit is contained in:
Daniel Marsee 2016-12-02 06:17:27 -10:00
parent 2ccaf82448
commit 1fe61195e5
1 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,6 +1,6 @@
#ELECTRIC# # ELECTRIC
##ABOUT Electric## ## ABOUT Electric
Electric is a 2-D, top-down in-flight shooter. Electric is a 2-D, top-down in-flight shooter.
Fight enemy forces as four air forces converge and battle in an intense team deathmatch vs. smart AI planes. Fight enemy forces as four air forces converge and battle in an intense team deathmatch vs. smart AI planes.
@ -10,12 +10,12 @@ Fight enemy forces as four air forces converge and battle in an intense team dea
* Use your favorite controller, or play with the classic keyboard. * Use your favorite controller, or play with the classic keyboard.
* Customize your team with colors and liveries. * Customize your team with colors and liveries.
##ABOUT THIS PROJECT## ## ABOUT THIS PROJECT
This repo is for the post-release maintenance of Electric. This repo is for the post-release maintenance of Electric.
Any new patches for bugfixes, enhancements, or cleanup will come from here. Any new patches for bugfixes, enhancements, or cleanup will come from here.
###What we will do:### ### What we will do:
* Improve performance over Electric 1.0 * Improve performance over Electric 1.0
* Fix bugs present in Electric 1.0 * Fix bugs present in Electric 1.0
@ -24,66 +24,66 @@ Any new patches for bugfixes, enhancements, or cleanup will come from here.
* Make code more efficient * Make code more efficient
* Create original music * Create original music
###What we will not do:### ### What we will not do:
* Change fundamental game mechanics * Change fundamental game mechanics
* Deviate from the original purpose of the game * Deviate from the original purpose of the game
* Deviate from the original look and feel of the game * Deviate from the original look and feel of the game
* Be an "early access" style rolling game * Be an "early access" style rolling game
##INSTALLING## ## INSTALLING
###Installer code will not be available at this time for this project.### ### Installer code will not be available at this time for this project.
1. You will need to compile the source code (electric.bas) yourself while maintaining the original directory structure 1. You will need to compile the source code (electric.bas) yourself while maintaining the original directory structure
You'll need Windows and an IDE called QB64 to build this, as it is written in a dialect of QuickBASIC You'll need Windows and an IDE called QB64 to build this, as it is written in a dialect of QuickBASIC
* Yes, it'll run on modern computers * Yes, it'll run on modern computers
2. You may either use the download button above to get a compressed version of this code, or you can use a Git client. 2. You may either use the download button above to get a compressed version of this code, or you can use a Git client.
To use the Git client to clone this repository, issure the following command: To use the Git client to clone this repository, issure the following command:
'git clone http://creamery.cheesewatergames.tk/rdmarsee/Electric.git' `git clone http://creamery.cheesewatergames.tk/rdmarsee/Electric.git`
3. Download and install QB64 3. Download and install QB64
4. Open your QB64 IDE and navigate to the Electric folder 4. Open your QB64 IDE and navigate to the Electric folder
5. Open "electric.bas" 5. Open "electric.bas"
6. In the QB64 window, select Run->Save EXE in the source folder 6. In the QB64 window, select Run->Save EXE in the source folder
###Optional:### ### Optional:
You may want to increase the size of the window in Options->Display and increasing Width and Height You may want to increase the size of the window in Options->Display and increasing Width and Height
To build and run, select Run->Start -or- hit F5 on your keyboard. To build and run, select Run->Start -or- hit F5 on your keyboard.
The Electric executible will now be in the Electric folder, ready to be run directly wihtout QB64. The Electric executible will now be in the Electric folder, ready to be run directly wihtout QB64.
##BRANCHES## ## BRANCHES
There are currently two branches you may clone. There are currently two branches you may clone.
###Master - This is the default, and preferred branch.### ### Master - This is the default, and preferred branch.
* Master will be kept clean and stable. If you follow proper procedure, it will always build on QB64 1.1 * Master will be kept clean and stable. If you follow proper procedure, it will always build on QB64 1.1
* Master will also keep runtime errors to a minimum. * Master will also keep runtime errors to a minimum.
* In fact, if you find a runtime error using Master, please log an issue to the issue tracker * In fact, if you find a runtime error using Master, please log an issue to the issue tracker
*You may also report any gameplay bugs or grievances for this branch *You may also report any gameplay bugs or grievances for this branch
*Do not report bugs or suggestions here that apply only to Electric 1_1. They'll be ignored. *Do not report bugs or suggestions here that apply only to Electric 1_1. They'll be ignored.
###1_1 - This is where the rapid development takes place.### ### 1_1 - This is where the rapid development takes place.
* Changes that may potentially break the game from time to time will be made here * Changes that may potentially break the game from time to time will be made here
* Expect runtime errors and occasional build errors. * Expect runtime errors and occasional build errors.
* Again, any runtime or build errors you see, please log in the issues tracker under this branch * Again, any runtime or build errors you see, please log in the issues tracker under this branch
*Do not log gameplay bugs or grievances in this branch - we're already working on them. *Do not log gameplay bugs or grievances in this branch - we're already working on them.
###In the future, there will be a 1_2 branch.### ### In the future, there will be a 1_2 branch.
At that time, 1.1 will become dormant and all new development will be focused towards 1.2 At that time, 1.1 will become dormant and all new development will be focused towards 1.2
* Exceptions for the 1_1 dormancy will be to fix critical bugs * Exceptions for the 1_1 dormancy will be to fix critical bugs
* There will be a final, binary release of 1_1 on the website. * There will be a final, binary release of 1_1 on the website.
###The game will be legacied after version 1_2### ### The game will be legacied after version 1_2
##FORKING## ## FORKING
Feel free to fork this project for your own purposes. WITH SOME MINOR EXCEPTIONS Feel free to fork this project for your own purposes. WITH SOME MINOR EXCEPTIONS
No matter how much you modify it, PLEASE give Cheese-Water Games credit for providing the original code. No matter how much you modify it, PLEASE give Cheese-Water Games credit for providing the original code.
Also, please don't simply re-release our code as-is under a different name. At least modify something. Also, please don't simply re-release our code as-is under a different name. At least modify something.
##THANK YOU!!!## ## THANK YOU!!!
####ABOUT CHEESE-WATER GAMES#### #### ABOUT CHEESE-WATER GAMES
Cheese-Water Games is the website for games made by Cheese-Water. Cheese-Water Games is the website for games made by Cheese-Water.