use markdown for readme and contributing guidelines

- https://github.com/github/markup
- https://github.com/blog/1184-contributing-guidelines
This commit is contained in:
Matthias Mailänder
2013-01-20 12:29:35 +01:00
committed by Chris Forbes
parent b00b1c36bc
commit f5835244c7
3 changed files with 64 additions and 5 deletions

45
README.md Normal file
View File

@@ -0,0 +1,45 @@
# OpenRA
A Libre/Free Real Time Strategy game engine supporting early Westwood classics.
* Website: [http://www.open-ra.org](http://www.open-ra.org)
* IRC: \#openra on irc.freenode.net
* Repository: [https://github.com/openra/openra](https://github.com/openra/openra)
Please read the [FAQ](https://github.com/OpenRA/OpenRA/wiki/FAQ) in our [Wiki](https://github.com/OpenRA/OpenRA/wiki) and report problems at [http://bugs.open-ra.org](http://bugs.open-ra.org).
Join the [Forums](http://www.sleipnirstuff.com/forum/viewforum.php?f=80) for discussion.
## Play
Distributed mods include a reimagining of
* Command & Conquer: Red Alert
* Command & Conquer: Tiberian Dawn
* Dune 2000 (experimental)
Check our [Playing the Game](https://github.com/OpenRA/OpenRA/wiki/Playing-the-game) Guide to win multiplayer matches.
## Contribute
* Please read [INSTALL](https://github.com/OpenRA/OpenRA/blob/bleed/INSTALL) and [Compiling](https://github.com/OpenRA/OpenRA/wiki/Compiling) on how to set up an OpenRA development environment.
* Read [HACKING](https://github.com/OpenRA/OpenRA/blob/bleed/HACKING) for an overview of the engine.
* To get your patches merged please adhere to the [Contributing](https://github.com/OpenRA/OpenRA/blob/bleed/CONTRIBUTING.md) guidelines.
* Some insights on the upcoming [Translation](https://github.com/OpenRA/OpenRA/wiki/Translation) framework.
## Mapping
* We offer a [Mapping](https://github.com/OpenRA/OpenRA/wiki/Mapping) Tutorial as you can change gameplay drastically with custom maps.
* If you want to share custom maps, mini-games and units with the community upload them at [http://content.open-ra.org](http://content.open-ra.org)
## Modding
* There exists an incomplete [Trait documentation](https://github.com/OpenRA/OpenRA/wiki/Trait-Documentation) to get started with yaml files.
* Check the [Modding Guide](https://github.com/OpenRA/OpenRA/wiki/Modding%20Guide) to create your own classic RTS.
* Some hints on to create new OpenRA compatible [Pixelart](https://github.com/OpenRA/OpenRA/wiki/Pixelart).
* Upload total conversions at [our ModDB profile](http://www.moddb.com/games/openra/mods)
## Support
* Sponsor a mirror server if you have some bandwidth to spare (ask in IRC).
* You can immediately set up a [Dedicated](https://github.com/OpenRA/OpenRA/wiki/Dedicated) Game Server.
* Fund development by creating [Bounties](https://www.bountysource.com/#repos/OpenRA/OpenRA) on specific tasks.