Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.34 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.34 KB
Raw

PGM XML Documentation

Documentation for the XML format PGM uses to define map specific features. Pages are hosted using github pages.

Editing Notes

  1. Pages are formated in markdown and may contain HTML, HTML should only be used where absolutely needed.
  2. Markdown is parsed with kramdown which has an enhanced syntax.
  3. Care should be taken when removing trailing whitespace since markdown uses two spaces to create a newline.

Pull Requests

Pull requests should have the following things:

  1. The commits should have a descriptive message and which is not in the past tense.

    For example:
    Describe the XYZ module with more detail. or Add detailed description for XYZ. is good, but: Added XYZ. isn't.

  2. Content should be grammatically correct and the spelling should be US English, e.g. Color not Colour.

Previewing your changes

  1. Install ruby (Mac, Windows, Ubuntu) (we don't need rails, so just install ruby)
  2. Install the bundler gem.
  3. Run bundle install from the source root.
  4. Run bundle exec jekyll serve or jekyll serve
  5. Load localhost:4000 in your browser.