aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNebuleon Fumika2012-12-20 19:06:04 -0500
committerNebuleon Fumika2012-12-20 19:06:04 -0500
commitdfab02b9136aad8070c02aaafa5a045faa47f958 (patch)
tree3f904c8e26e00b5ae758cb59c03f68dd23258079 /README.md
parent90fbc11b7a311a8f13fc8abdf74ddedfabc66b07 (diff)
downloadsnes9x2005-dfab02b9136aad8070c02aaafa5a045faa47f958.tar.gz
snes9x2005-dfab02b9136aad8070c02aaafa5a045faa47f958.tar.bz2
snes9x2005-dfab02b9136aad8070c02aaafa5a045faa47f958.zip
Use Markdown-style sections. I thought == == worked...
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 25 insertions, 12 deletions
diff --git a/README.md b/README.md
index 33b4af4..94fb949 100644
--- a/README.md
+++ b/README.md
@@ -9,12 +9,12 @@ Based on:
* BAGSFC, by BassAceGold (improving over NDSSFC)
* CATSFC, by ShadauxCat (improving over BAGSFC)
-== Compiling ==
+# Compiling
Compiling CATSFC is best done on Linux. Make sure you have access to a Linux
system to perform these steps.
-=== The DS2 SDK ===
+## The DS2 SDK
To compile CATSFC, you need to have the Supercard team's DS2 SDK.
The Makefile expects it at `/opt/ds2sdk`, but you can move it anywhere,
provided that you update the Makefile's `DS2SDKPATH` variable to point to it.
@@ -24,30 +24,30 @@ MIPS compiler (`gcc`), extract it to `/opt/ds2sdk`, follow the instructions,
then download version 1.2 of the DS2 SDK and extract its files into
`opt/ds2sdk`, overwriting version 0.13.
-=== The MIPS compiler (`gcc`) ===
+## The MIPS compiler (`gcc`)
You also need the MIPS compiler from the DS2 SDK.
The Makefile expects it at `/opt/mipsel-4.1.2-nopic`, but you can move it
anywhere, provided that you update the Makefile's `CROSS` variable to point to
it.
-=== Making the plugin ===
+## Making the plugin
To make the plugin, `catsfc.plg`, use the `cd` command to change to the
directory containing your copy of the CATSFC source, then type
`make clean; make`. `catsfc.plg` should appear in the same directory.
-== Installing ==
+# Installing
To install the plugin to your storage card after compiling it, copy
`catsfc.plg`, `catsfc.ini` and `catsfc.bmp` to the card's `_dstwoplug`
directory. Then, copy the source directory's CATSFC subdirectory to the
root of the card.
-== The font ==
+# The font
The font used by CATSFC is now similar to the Pictochat font. To modify it,
see `source/font/README.txt`.
-== Translations ==
+# Translations
Translations for CATSFC may be submitted to the author(s) under many forms,
one of which is the Github pull request. To complete a translation, you will
@@ -63,18 +63,31 @@ need to do the following:
* Edit `source/nds/message.h`. Find `enum LANGUAGE` and add the name of your
language there. For the example of German, you would add this at the end of
the list:
- `, GERMAN`
+ ```
+ ,
+ GERMAN
+ ```
* Still in `source/nds/message.h`, just below `enum LANGUAGE`, you will find
- `extern char* lang[` /some number/ `]`. Add 1 to that number.
-* Edit `source/nds/gui.c`. Find `char *lang[` /some number/ `] =`.
+ `extern char* lang[` *some number* `]`. Add 1 to that number.
+* Edit `source/nds/gui.c`. Find `char *lang[` *some number* `] =`.
Add the name of your language, in the language itself. For the example of
German, you would add this at the end of the list:
- `, "Deutsch"`
+ ```
+ ,
+ "Deutsch"
+ ```
* Still in `source/nds/gui.c`, find `case CHINESE_SIMPLIFIED`. Copy the lines
starting at the `case` and ending with `break`, inclusively. Paste them
before the `}`. Change the language name and tags, and update the `cmplen`
to be the length of the `START` tag. For the example of German, you would
- use `cmplen= 11;`, because that's the length of `STARTGERMAN`.
+ use `cmplen= 11;`, because that's the length of `STARTGERMAN`:
+ ```C
+ case GERMAN:
+ strcpy(start, "STARTGERMAN");
+ strcpy(end, "ENDGERMAN");
+ cmplen = 11;
+ break;
+ ```
Compile again, copy the plugin and your new `language.msg` to your card
under `CATSFC/system`, and you can now select your new language in CATSFC!