duuqnd/cave-story-solaris
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More PHILOSOPHY.md tidying

Browse source
This commit is contained in:
Clownacy 2020-09-14 13:29:27 +01:00
parent f9fa8ccbbf
commit 2446ec02c8
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
PHILOSOPHY.md
View file

@ -25,34 +25,36 @@ know from the [Organya source code release](https://github.com/shbow/organya/)
what Pixel's code-style looked like, and I find it **extremely** hard to read. what Pixel's code-style looked like, and I find it **extremely** hard to read.
## Language ## Language
Cave Story's developer, Pixel, primarily speaks Japanese, but his code's Cave Story's developer (Pixel) primarily speaks Japanese, but his code's
variable/function names are mostly written in English (with a few rare instances variable/function names are mostly written in English (with a few rare instances
of Romanised Japanese). of Romanised Japanese).
The Organya source code release indicates Pixel wrote his comments in Japanese, The Organya source code release indicates that Pixel wrote his comments in
however, in this project, I prefer them to be written in English. Japanese, however, in this project, I prefer them to be written in English.
The English employed in this project is a mix of American English, Canadian The English employed in this project is a mix of American English, Canadian
English, and British English. English, and British English.
# `portable` branch # `portable` branch
This branch takes a different direction to the `accurate` branch, but they still This branch takes a different direction to the `accurate` branch, but they still
share some core philosophies: share many core philosophies:
## Goal ## Goal
While accurately-reproducing Cave Story's original code is still a priority, the While accurately-reproducing Cave Story's original code is still a priority, the
main focus of this branch is to port the game to other platforms, while also main focus of this branch is to port the game to other platforms, while also
preserving the original experience of the game as it was back in 2004. preserving the game the way it was experienced back in 2004.
Essentially, this branch exists to provide a purist Cave Story experience Essentially, this branch exists to provide a purist Cave Story experience
without requiring an old Windows XP computer. without requiring an old Windows XP computer.
Notably, this means bugs should still be left intact. However, bugs and other Notably, this means that bugs should still be left intact. However, bugs and
coding errors that affect portability should be fixed. other coding errors that affect portability should be fixed.
For comparison, I believe this branch shares some parallels with the For comparison, I believe this branch shares many parallels with the
Chocolate Doom project, except perhaps more strict. See the link below for their Chocolate Doom project. Follow the link below to see that project's list of
list of philosophies which may be applicable here: philosophies, which may be applicable here:
https://github.com/chocolate-doom/chocolate-doom/blob/master/PHILOSOPHY.md https://github.com/chocolate-doom/chocolate-doom/blob/master/PHILOSOPHY.md