Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.49 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.49 KB

About

This is the source of haxepunk.com. It is hosted on GitHub Pages using jekyll. You can compile and test this website on your computer with a local install of jekyll, pull requests are welcome.

  1. Install jekyll

  2. Clone and run the server

    git clone https://github.com/HaxePunk/haxepunk.com.git
cd haxepunk.com
jekyll serve --watch --baseurl "/"

  3. Open http://localhost:4000

  4. Start hacking on the site. The --watch parameter will live reload the site every time a file is changed and saved.

Contributing

If you want to contribute and improve our website please work on a fork. Only working and tested changes will be merged. Use the issue system for developer support and approval on your changes.

Adding a Game

Once you've made something in HaxePunk you can submit it to be showcased on the website.

  1. Create a .md file inside the games folder following this example:

    ---
layout: game
title: My Game Title
play_url: http://mygamesite.com/play/
author: My Name
---

This is a description of my **really** great game! You can use Markdown to format the description.

  2. Add a screenshot using the same filename of your .md file to the img/games folder. The image is scaled to 220x124 so it's best to keep to those dimensions.