ShuriZma
/
xenia-canary
mirror of https://github.com/xenia-canary/xenia-canary.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Formatting, cleanup

Margen67 2023-06-12 06:10:52 -07:00
parent 37ff027f0b
commit da1f6c490f
2 changed files with 0 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
About.md

@ -4,7 +4,6 @@
TODO TODO
--> -->
### Project Origin ### Project Origin
The project began when I ([@benvanik](https://twitter.com/benvanik)) was between The project began when I ([@benvanik](https://twitter.com/benvanik)) was between
jobs and wanted to hack on something fun. I'd picked up some region-locked jobs and wanted to hack on something fun. I'd picked up some region-locked
Japanese games when I was visiting Tokyo and was frustrated I couldn't play them Japanese games when I was visiting Tokyo and was frustrated I couldn't play them
@ -16,17 +15,13 @@ spare time when bored (or when [@gibbed](https://twitter.com/gibbed) has some
time and gets me excited). time and gets me excited).
### Why? ### Why?
Because it's fun! Because it's fun!
### Future Plans ### Future Plans
None! There's a [roadmap](../wiki/roadmap), but the project has largely achieved what None! There's a [roadmap](../wiki/roadmap), but the project has largely achieved what
I set out for it to do (waste time building something cool), and now is purely a I set out for it to do (waste time building something cool), and now is purely a
passion project in my spare time. In addition to getting some of my favorite passion project in my spare time. In addition to getting some of my favorite
games to play I'm really just hacking to have fun. games to play I'm really just hacking to have fun.
## Team ## Team
Contributors can be seen [here on GitHub](../graphs/contributors). Contributors can be seen [here on GitHub](../graphs/contributors).
<!--TODO: auto generate a list from API.-->

10
For-Developers.md

@ -1,5 +1,4 @@
# Does Xenia run on Linux or macOS? # Does Xenia run on Linux or macOS?
The project is designed to support non-Windows platforms but until it's running The project is designed to support non-Windows platforms but until it's running
games it's not worth the maintenance burden. MacOS will likely remain unsupported games it's not worth the maintenance burden. MacOS will likely remain unsupported
until Apple supports Vulkan. until Apple supports Vulkan.
@ -12,9 +11,7 @@ Though the codebase is ready for the port, it's not a trivial task and anyone
seeking to port it will need a deep understanding of Linux, X11, Vulkan, and seeking to port it will need a deep understanding of Linux, X11, Vulkan, and
Win32 (to ensure matching semantics). Win32 (to ensure matching semantics).
# You should port it to Linux, then tons of developers will contribute! # You should port it to Linux, then tons of developers will contribute!
No, they won't, and that's not how things work. (I'm seriously told this once No, they won't, and that's not how things work. (I'm seriously told this once
a week...) a week...)
@ -24,18 +21,14 @@ has this capability and feels so strongly about Linux support then they would be
contributing to the porting efforts already. But otherwise they are nothing contributing to the porting efforts already. But otherwise they are nothing
more than hypothetical members of our collective dreams. more than hypothetical members of our collective dreams.
# Why did you do X? Why not just use Y? You should use Y. NIH NIH NIH! # 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 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 reason for what I did. This is a large project that I've been working on
for almost 5 years and in that time new compilers and language specs have for almost 5 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. been released, libraries have been created and died, and I've learned a lot.
Constructive contributions and improvements are welcome. Constructive contributions and improvements are welcome.
# Have you heard of LLVM/asmjit/jitasm/luajit/etc? # Have you heard of LLVM/asmjit/jitasm/luajit/etc?
Yes, I have heard of them. In fact, I spent a long time trying them out: Yes, I have heard of them. In fact, I spent a long time trying them out:
[LLVM](https://github.com/xenia-project/xenia/tree/85bdbd24d1b5923cfb104f45194a96e7ac57026e/src/xenia/cpu/codegen), [LLVM](https://github.com/xenia-project/xenia/tree/85bdbd24d1b5923cfb104f45194a96e7ac57026e/src/xenia/cpu/codegen),
[libjit](https://github.com/xenia-project/xenia/tree/eee856be0499a4bc721b6097f5f2b9446929f2cc/src/xenia/cpu/libjit), [libjit](https://github.com/xenia-project/xenia/tree/eee856be0499a4bc721b6097f5f2b9446929f2cc/src/xenia/cpu/libjit),
@ -44,9 +37,7 @@ I did not find them acceptable for use in this project for various reasons. If
for some reason you feel strongly otherwise, feel free to either contribute a for some reason you feel strongly otherwise, feel free to either contribute a
[new CPU backend](https://github.com/xenia-project/xenia/tree/master/src/xenia/cpu/backend). [new CPU backend](https://github.com/xenia-project/xenia/tree/master/src/xenia/cpu/backend).
# (some argument over an unimportant technical choice) # (some argument over an unimportant technical choice)
In general: *I don't care*. In general: *I don't care*.
That means I either really don't care and something is they way it is because That means I either really don't care and something is they way it is because
that was convenient or that I don't care because it's not material to the goal that was convenient or that I don't care because it's not material to the goal
@ -68,7 +59,6 @@ projects. Premake does what I want (mostly) how I want it to.
# Hey I'm going to go modify every file in the project, ok? # Hey I'm going to go modify every file in the project, ok?
We welcome contributions, but please try to understand that we cannot accept We welcome contributions, but please try to understand that we cannot accept
changes that radically alter the structure or content of the code, especially 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 if they are aesthetic and even more so if they are from someone who has not