diff options
| author | Ben Vanik <ben.vanik@gmail.com> | 2015-08-28 14:16:38 -0700 |
|---|---|---|
| committer | Ben Vanik <ben.vanik@gmail.com> | 2015-08-28 14:16:38 -0700 |
| commit | a79ef878893dbcdc0557ce784b55bdf7547ff0cb (patch) | |
| tree | 2ebe6f4d2574e6021be057a3c5e29b9d6ea75fb5 /README.md | |
| parent | 45816d801bf24781b1a9e773fa234cf75f68cbf0 (diff) | |
Adding CONTRIBUTING.md so that github shows it on issues.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 17 insertions, 3 deletions
@@ -16,6 +16,8 @@ Please check the [frequently asked questions](http://xenia.jp/faq/) page before asking questions. We've got jobs/lives/etc, so don't expect instant answers. Discussing illegal activities will get you banned. No warnings. +**Before contributing code or issues be sure to read [CONTRIBUTING.md](CONTRIBUTING.md).** + ## Status Buildbot: @@ -25,7 +27,9 @@ Project tracker: [](http://waffle.io/benvanik/xenia) [](http://waffle.io/benvanik/xenia) -Some real games run. Most don't. Don't ask if GTA or whatever runs. [Game compatibility list](https://github.com/xenia-project/game-compatibility/issues). +Some real games run. Most don't. Don't ask if GTA or whatever runs. +See the [Game compatibility list](https://github.com/xenia-project/game-compatibility/issues) +for currently tracked games. ## Disclaimer @@ -42,20 +46,29 @@ Windows 8.1+ with Python 2.7 and [Visual Studio 2015](https://www.visualstudio.c > git clone https://github.com/benvanik/xenia.git > cd xenia > xb setup + + # Pull latest changes, rebase, and update submodules and premake: + > xb pull + # Build on command line: > xb build + # Run premake and open Visual Studio (run the 'xenia-app' project): > xb devenv + # Run premake to update the sln/vcproj's: > xb premake + # Format code to the style guide: + > xb format + When fetching updates use `xb pull` to automatically fetch everything and run premake for project files/etc. ## Building -See [building](docs/building.md) for setup and information about the -`xb` script. When writing code, check the [style guide](docs/style_guide.md) +See [building.md](building.md) for setup and information about the +`xb` script. When writing code, check the [style guide](style_guide.md) and be sure to run clang-format! ## Contributors Wanted! @@ -69,6 +82,7 @@ that there are some major work areas still untouched: * Help work through missing functionality/bugs in game [compat](https://github.com/benvanik/xenia/issues?labels=compat) * Add input drivers for [PS4 controllers](https://github.com/benvanik/xenia/issues/60) (or anything else) +* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/benvanik/xenia/labels/cross%20platform) See more projects [good for contributors](https://github.com/benvanik/xenia/issues?labels=good+for+contributors&page=1&state=open). It's a good idea to ask on IRC/the bugs before beginning work on something. |
