diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 92% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 1b2523763..e20dd4414 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,9 +26,9 @@ could result in the project being terminated, so just don't do it. ## Style Guide -Please read over [style_guide.md](docs/style_guide.md) before sending pull requests +Please read over [style_guide.md](../docs/style_guide.md) before sending pull requests and ensure your code is clean as the buildbot (or I) will make you to fix it :) -[style_guide.md](docs/style_guide.md) has information about using `xb format` and +[style_guide.md](../docs/style_guide.md) has information about using `xb format` and various IDE auto formatting tools so that you can avoid having to clean things up later, so be sure to check it out. @@ -62,10 +62,10 @@ things clean and easy. # License All xenia code is licensed under the 3-clause BSD license as detailed in -[LICENSE](LICENSE). Code under `third_party/` is licensed under its original +[LICENSE](../LICENSE). Code under `third_party/` is licensed under its original license. -Incoming code in pull requests are subject to the xenia [LICENSE](LICENSE). +Incoming code in pull requests are subject to the xenia [LICENSE](../LICENSE). Once code comes into the codebase it is very difficult to ever fully remove so copyright is ascribed to the project to prevent future disputes such as what occurred in [Dolphin](https://dolphin-emu.org/blog/2015/05/25/relicensing-dolphin/). diff --git a/README.md b/README.md index c0052f32c..d3fc9ffae 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,13 @@ and be sure to run clang-format! ## Contributors Wanted! -**Before contributing code or issues be sure to read [CONTRIBUTING.md](CONTRIBUTING.md).** +**Before contributing code or issues be sure to read [CONTRIBUTING.md](.github/CONTRIBUTING.md).** Have some spare time, know advanced C++, and want to write an emulator? Contribute! There's a ton of work that needs to be done, a lot of which is wide open greenfield fun. -For general rules and guidelines please see [CONTRIBUTING.md](CONTRIBUTING.md). +For general rules and guidelines please see [CONTRIBUTING.md](./github/CONTRIBUTING.md). Fixes and optimizations are always welcome (please!), but in addition to that there are some major work areas still untouched: @@ -81,7 +81,7 @@ that there are some major work areas still untouched: * 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 +See more projects [good for contributors](https://github.com/benvanik/xenia/labels/good%20for%20contributors). It's a good idea to ask on IRC/the bugs before beginning work on something. ## FAQ @@ -90,5 +90,5 @@ For more see the main [frequently asked questions](http://xenia.jp/faq/) page. ### Can I get an exe? -Check the [Releases](https://github.com/benvanik/xenia/releases) tab to see -what's there. Updated irregularly. +Check the [Artifacts](https://ci.appveyor.com/project/benvanik/xenia/build/artifacts) tab to see +what's there.