From 55052b0d92d6f24807f3504584c33ec55d3a73f3 Mon Sep 17 00:00:00 2001 From: Ben Vanik Date: Fri, 24 Jan 2014 12:59:28 -0800 Subject: [PATCH] Update README.md --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1a23b29d..63525bece 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,14 @@ be better to wait a bit until things calm down and more of the code is documente Come chat with us **about development topics** in [#xenia @ irc.freenode.net](http://webchat.freenode.net?channels=%23xenia&uio=MTE9NzIaa). -Current status: +## NOTE + +I'd much rather write code than entertain jerks. If you're ignored or treated with +curtness perhaps you should reflect upon what you did that would cause that to +happen. This is a project done for fun and random internet arguments diminish +that. + +## Status * Some code runs. [Insert any game name here] doesn't. * Asserts! Crashes! Hangs! Blank screens! @@ -45,8 +52,6 @@ See [building](docs/building.md) for setup and information about the ## Contributors Wanted! -[![Stories in Ready](https://badge.waffle.io/benvanik/xenia.png?label=ready)](https://waffle.io/benvanik/xenia) - 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. @@ -97,11 +102,48 @@ non-Windows platforms. ### What kind of GPU do I need? DirectX 11 support is required. To get full speed and compatibility Mantle may -be required in the future (which means R9 AMD cards and up). +be required in the future. + +### Have you heard of LLVM/asmjit/jitasm/luajit/etc? + +I get asked this about once a day. Yes, I have heard of them. In fact, I spent +a long time trying them out: +[LLVM](https://github.com/benvanik/xenia/tree/85bdbd24d1b5923cfb104f45194a96e7ac57026e/src/xenia/cpu/codegen), +[libjit](https://github.com/benvanik/xenia/tree/eee856be0499a4bc721b6097f5f2b9446929f2cc/src/xenia/cpu/libjit), +[asmjit](https://github.com/benvanik/xenia/tree/ca208fa60a0285d396409743064784cc2320c094/src/xenia/cpu/x64). +They don't work for this purpose. I understand if you disagree, but please +understand that I've spent a significant amount of time on this problem. + +### Why did you do X? Why not just use Y? You should use Y. NIH NIH NIH! + +Trust that I either have a good reason for what I did or have absolutely no +reason for what I did. This is a large project that I've been working on +for almost 4 years and in that time new compilers and language specs have +been released, libraries have been created and died, and I've learned a lot. +Insulting me will get you ignored. + +### Hey I'm going to go modify every file in the project, ok? + +I welcome contributions, but please try to understand that I cannot accept +changes that radically alter the structure or content of the code, especially +if they are aesthetic and even more so if they are from someone who has not +contributed before. This may seem like common sense, but apparently it isn't. +If a pull request of this nature is denied that doesn't necessarily mean your +help is not wanted, just that it may need to be more carefully applied. + +### I have a copy of the XDK. Do you want it? + +No. ### (some argument over an unimportant technical choice) In general: 'I don't care.' +That means I either really don't care and something is they way it is because +that was convienient (such as GYP, which I am familiar with), or that +I don't care because it's not material to the goal of the project. There are +a million important things that need to be done to get games running and +going back and forth about unimportant orthogonal issues does not help. +If you really do have a better way of doing something and can show it, do so. Here's a short list of common ones: