Difference between revisions of "Documentation"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(complete rewrite)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''BOARD18 documentation has been divided into four categories based on the target audience.'''
{{ReleaseNotice|1.2}}
The primary purpose of this WIKI is to document BOARD18. But there are many
subjects that comprise this documentation and finding the information that you need
could be a problem. The links on this page are an attempt to help solve this information access problem.


==Player Documentation==
Anyone wishing to use BOARD18 to play an 18xx game by email should read the '''[[Player's Guide|BOARD18 Player's Guide]]'''. The current release of this guide should contain
Anyone wishing to use BOARD18 to play an 18xx game by email should read the '''[[Player's Guide|BOARD18 Player's Guide]]'''.<br>
everything that you need to "get on board" with BOARD18.
This guide is also available via the "Help" option on the BOARD18 main menu.
This guide is also available via the "Help" option on the BOARD18 main menu.


==Game Box Documentation==
One of the concepts that drove the design of BOARD18 was keeping the '''game box''' for
If you wish to create Game Boxes for specific 18xx Games, then you should read the '''[[Game_Box_Creation_-_Introduction|game box documentation]]'''.
each 18xx title separate from the actual BOARD18 code. The idea was that non programmer
types could make game boxes. Much like they can and do make spreadsheets to handle the
financial side of PBEM games.
If you wish to create a Game Box for specific 18xx Game, then you should read the '''[[Game_Box_Creation_-_Introduction|game box documentation]]'''.


==Administrator Documentation==
BOARD18 is freely available and can be downloaded from this WIKI at no charge. This means
If you wish to create your own BOARD18 web site, then you should read the '''[[Administrator|administrator documentation]]'''.  
that anyone that has access to a web server can run his own BOARD18 web site!
If you wish to create your own BOARD18 web site, then you should read the '''[[Administrator|site owner documentation]]'''.  


==Developer Documentation==
Finly, if you wish to contribute to the design and implementation of BOARD18, then you  
If you wish to contribute to the design and implementation of BOARD18, then you should read the '''[[Developer|developer documentation]]'''.
should read the '''[[Developer|developer documentation]]''' and the
'''[[Design Document Introduction|BOARD18 Design Document]]'''.

Revision as of 18:11, 18 September 2015

This page has been updated to comply with Release 1.2.x of BOARD18.

The primary purpose of this WIKI is to document BOARD18. But there are many subjects that comprise this documentation and finding the information that you need could be a problem. The links on this page are an attempt to help solve this information access problem.

Anyone wishing to use BOARD18 to play an 18xx game by email should read the BOARD18 Player's Guide. The current release of this guide should contain everything that you need to "get on board" with BOARD18. This guide is also available via the "Help" option on the BOARD18 main menu.

One of the concepts that drove the design of BOARD18 was keeping the game box for each 18xx title separate from the actual BOARD18 code. The idea was that non programmer types could make game boxes. Much like they can and do make spreadsheets to handle the financial side of PBEM games. If you wish to create a Game Box for specific 18xx Game, then you should read the game box documentation.

BOARD18 is freely available and can be downloaded from this WIKI at no charge. This means that anyone that has access to a web server can run his own BOARD18 web site! If you wish to create your own BOARD18 web site, then you should read the site owner documentation.

Finly, if you wish to contribute to the design and implementation of BOARD18, then you should read the developer documentation and the BOARD18 Design Document.