Migrate internal game documentation to Markdown.

Minor fixes to info view.
This commit is contained in:
Dorian 2014-08-20 07:57:04 -04:00
parent 0039466767
commit 0a8fdc0e93
5 changed files with 66 additions and 46 deletions

View File

@ -0,0 +1,62 @@
What is justCheckers?
---------------------
justCheckers is an advanced libre source checkers game. The project's aim is to create a checkers game that:
* handles skins and themes
* handles multimedia
* allows for network games
* contains a powerful yet fun computer opponent
* simplifies managing on-line checkers tournaments
* handles different checker rules
This project is powered by Python 2 + PySide (Qt 4)
[justCheckers homepage - http://justcheckers.org/](http://justcheckers.org/)
Developers
==========
Current
-------
**Dorian Pula**
- Founder, lead developer, project management, documentation & core programming.
Past
----
**Chris Bellini**
- Game engine data objects, XML settings & project management.
- Versions 0.0-0.1
**Daniel D'Alimonte (skwirl)**
- Code clean-up, refactoring, documentation & file releases.
- Inspiration for move to PySide
- Versions 0.0-0.1
**Ross Etchells**
- Game engine logic and progressing.
- Versions 0.0-0.1
**Rras Lekone**
- Console UI (jCurses)
- Versions 0.0
**Brinick Simmons**
- Core programming, XML settings and processing.
- Versions 0.0-0.1
Special Thanks
--------------
**Nick Nolfi**
- Creator of the Chubby Checkers project and assignment.
- Inspiration for Civilization Checkers and justCheckers.

View File

@ -1,42 +0,0 @@
== What is justCheckers? ==
justCheckers is an open source advanced checkers game built using Java. The aim
of the project is to create a checkers game that:
* handles skins and themes
* handles multimedia
* allows for network games
* contains a powerful yet fun computer opponent
* simplifies managing on-line checkers tournaments
* handles different checker rules
Project homepage: http://justcheckers.sourceforge.net/
== Current Developers ==
* Dorian Pula
** Founder, lead developer, project management, documentation & core programming.
== Past Developers ==
* Chris Bellini
** Game engine data objects, XML settings & project management.
** Versions 0.0-0.1
* Daniel D'Alimonte (skwirl)
** Code clean-up, refactoring, documentation & file releases.
** Versions 0.0-0.1
* Ross Etchells
** Game engine logic and progressing.
** Versions 0.0-0.1
* Rras Lekone
** Console UI (jCurses)
** Versions 0.0
* Brinick Simmons
** Core programming, XML settings and processing.
** Versions 0.0-0.1
== Inspiration ==
* Nick Nolfi
** Creator of the Chubby Checkers project and assignment.
** Inspiration for Civilization Checkers and justCheckers.

View File

@ -38,7 +38,7 @@ class InfoView(QtGui.QWidget):
def setup_components(self): def setup_components(self):
self.info_viewer = QtWebKit.QWebView(self) self.info_viewer = QtWebKit.QWebView(self)
about_html = self.generate_html_from_markdown('readme.txt') about_html = self.generate_html_from_markdown('credits.md')
self.info_viewer.setHtml(about_html) self.info_viewer.setHtml(about_html)
exit_button = QtGui.QPushButton('Back to Menu', self) exit_button = QtGui.QPushButton('Back to Menu', self)
@ -69,11 +69,11 @@ class InfoView(QtGui.QWidget):
self.parentWidget().setCurrentIndex(0) self.parentWidget().setCurrentIndex(0)
def display_about_info(self): def display_about_info(self):
about_html = self.generate_html_from_markdown('readme.txt') about_html = self.generate_html_from_markdown('credits.md')
self.info_viewer.setHtml(about_html) self.info_viewer.setHtml(about_html)
def display_license_info(self): def display_license_info(self):
license_html = self.generate_html_from_markdown('gpl_3_license.txt') license_html = self.generate_html_from_markdown('license.md')
self.info_viewer.setHtml(license_html) self.info_viewer.setHtml(license_html)
def generate_html_from_markdown(self, filename): def generate_html_from_markdown(self, filename):

View File

@ -43,8 +43,8 @@ class MainMenuView(QtGui.QWidget):
self.about_game = self.create_menu_button('About Game', enabled=True) self.about_game = self.create_menu_button('About Game', enabled=True)
self.about_game.clicked.connect(self.switch_to_about_view) self.about_game.clicked.connect(self.switch_to_about_view)
# TODO Add links to site and display license inside about game widget.
self.settings = self.create_menu_button('Settings') self.settings = self.create_menu_button('Settings')
self.exit_button = self.create_menu_button('Exit', enabled=True) self.exit_button = self.create_menu_button('Exit', enabled=True)
self.exit_button.clicked.connect(self.exit_app) self.exit_button.clicked.connect(self.exit_app)