From 996c7b493e6111533b8c919b98b49cf7ce29bc45 Mon Sep 17 00:00:00 2001
From: mrdudz <mrdudz@users.noreply.github.com>
Date: Thu, 16 Jul 2015 21:39:13 +0200
Subject: [PATCH] moved all notes into regular documentation

---
 doc/pce.sgml          | 23 ++++++++++++++++++++++-
 libsrc/pce/readme.txt | 36 ------------------------------------
 2 files changed, 22 insertions(+), 37 deletions(-)
 delete mode 100644 libsrc/pce/readme.txt

diff --git a/doc/pce.sgml b/doc/pce.sgml
index 2d14e8361..74692ce16 100644
--- a/doc/pce.sgml
+++ b/doc/pce.sgml
@@ -130,6 +130,8 @@ No extended memory drivers are currently available for the PCE.
   <tag><tt/pce-stdjoy.joy (pce_stdjoy)/</tag>
   A joystick driver for the standard two buttons joypad is available.
 
+  Note that the japanese 6-button pad is currently not supported.
+
 </descrip><p>
 
 
@@ -146,6 +148,10 @@ No serial drivers are currently available for the PCE.
 
 <sect>Limitations<p>
 
+<itemize>
+<item>interruptor support in crt0 (and cfg) is missing
+</itemize>
+
 <sect1>Disk I/O<p>
 
 The existing library for the PCE doesn't implement C file
@@ -155,6 +161,7 @@ To be more concrete, this limitation means that you cannot use any of the
 following functions (and a few others):
 
 <itemize>
+<item>printf
 <item>fclose
 <item>fopen
 <item>fread
@@ -165,11 +172,25 @@ following functions (and a few others):
 <item>...
 </itemize>
 
+<sect>Other hints<p>
 
+<itemize>
+<item>a good emulator to use for PC-Engine is "mednafen" (<url url="http://mednafen.sourceforge.net">)
+</itemize>
 
-<sect>Other hints<p>
+some useful resources on PCE coding:
 
+<itemize>
+<item><url url="http://blog.blockos.org/?tag=pc-engine">
+<item><url url="http://pcedev.blockos.org/viewforum.php?f=5">
+<item><url url="http://www.romhacking.net/?page=documents&amp;category=&amp;platform=4&amp:game=&amp;author=&amp;perpage=20&amp;level=&amp;title=&amp;desc=&amp;docsearch=Go">
+<item><url url="http://archaicpixels.com/Main_Page">
 
+<item><url url="http://www.magicengine.com/mkit/doc.html">
+
+<item><url url="https://github.com/uli/huc">
+<item><url url="http://www.zeograd.com/parse.php?src=hucf">
+</itemize>
 
 <sect>License<p>
 
diff --git a/libsrc/pce/readme.txt b/libsrc/pce/readme.txt
deleted file mode 100644
index a822205d4..000000000
--- a/libsrc/pce/readme.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-PC-Engine (PCE) target support for cc65. this is still work in progress and
-a couple of things need to be fixed:
---------------------------------------------------------------------------------
-
-- 6 button gamepads are different and need slightly different code
-
-interruptor support in crt0 (and cfg) is missing
-- clock() should be hooked to a VBL interrupt
-
---------------------------------------------------------------------------------
-
-a good emulator to use for PC-Engine is "mednafen" (mednafen.sourceforge.net)
-
-run the compiled binary like this:
-
-> mednafen -force_module pce <yourprogram.pce>
-
-joypad keys are mapped like this:
-
-w/s/a/d         up/down/left/right
-numpad 2        (?) button
-numpad 3        (?) button
-enter           (start) button
-
---------------------------------------------------------------------------------
-some useful resources on PCE coding:
-
-http://blog.blockos.org/?tag=pc-engine
-http://pcedev.blockos.org/viewforum.php?f=5
-http://www.romhacking.net/?page=documents&category=&platform=4&game=&author=&perpage=20&level=&title=&desc=&docsearch=Go
-http://archaicpixels.com/Main_Page
-
-http://www.magicengine.com/mkit/doc.html
-
-https://github.com/uli/huc
-http://www.zeograd.com/parse.php?src=hucf
-- 
2.39.5