update some docs to reflect new layout

README.md

@@ -10,18 +10,18 @@ Status
 The primary goal right now is to get the library coded, as well as provide
 examples that use the library. Overall, the tasks can be broken down as follows:
 
-(All percentage completions are estimates as of 2015/03/13. No project is ever truly finished. :wink:)
+(All percentage completions are estimates as of 2015/11/13. No project is ever truly finished. :wink:)
 
 ### Library ###
 These elements form the core of the freemlib for Neo-Geo.
 
 * **Animation** – Sprite animation. 0%.
 * **Backgrounds** – Routines for background sprites. 0%.
 * **Collision** – Most every game needs some sort of collision. 0%.
-* **Fix** – Fix layer functionality. Still needs work, ~22.5%?
+* **Fix** – Fix layer functionality. Still needs work, ~23%?
 * **Memory Card** – Handle Memory Cards (also Neo-Geo CD Backup Memory). 5%, needs testing.
 * **Palette** – Palette functionality. ~10%.
-* **Sound** – Fully-featured (FM, SSG, both ADPCM types, CD/DA) Z80 sound engine. 3%.
+* **Sound** – Fully-featured (FM, SSG, both ADPCM types, CD/DA) Z80 sound engine. 4%.
 * **Sprites** – General sprite functionality. ~15%?, with restructuring to come.
 * **System** – Various system functions. 1%.
 
@@ -33,9 +33,9 @@ Various tools to help you produce content for the Neo-Geo. Special consideration
 should be made for Linux (and OS X) compatibility whenever possible.
 
 * **NeoFixFormat** – Fix format tiles plugin for YY-CHR.NET. 100%, unless a bug comes up.
-* **NeoGeoTracker** – On-console tracker and sound driver testbench. 0% (mockups and planning stage)
-* **Sailor VROM** – V ROM/.PCM file builder and manager. 25% ([https://github.com/freem/freemlib-neogeo/tree/master/tools/sailorvrom/lua](Lua version available))
-* **4BPP SMS/GG/WSC to Neo-Geo ".c0" Format tool** – 100% for the time being. Source code needs uploading (might be here, might be elsewhere)
+* **Sailor VROM** – V ROM/.PCM file builder and manager. 25%, but usable. ([https://github.com/freem/freemlib-neogeo/tree/master/tools/sailorvrom/lua](Lua version available))
+* **4BPP SMS/GG/WSC to Neo-Geo ".c0" Format tool** – 100% for the time being. ([https://github.com/freem/NeoSpriteConv](project repository))
+* **NeoGeoTracker** – On-console tracker and sound driver testbench. 0% (mockups and planning stage, might take a while)
 * and others not listed here...
  * A tool for Fix layer layout, similar to Shiru's NES Screen Tool
  * A tool for animation data (various tools exist already, I'm aware.)
@@ -58,7 +58,8 @@ Navigation
 * `cdfiles/` – Files required for Neo-Geo CD games (aside from `IPL.TXT`)
 * `doc/` – Documentation (both general and freemlib related)
 * `examples/` – freemlib Usage Examples
-* `src/` – The freemlib library code.
+* `src_68k/` – Main freemlib library code.
+* `src_z80/` – freemlib sound engine code.
 * `tools/` – Various tools.
 
 You should read `doc/usage.txt` for how to setup a project with the freemlib.

doc/TITLE_x_SYS.txt

@@ -9,7 +9,7 @@ Following that are 40 sprite tiles in the regular SPR file format, making a 9*5
 tiles (144*80 pixels) logo. Tiles are mapped from left to right, top to bottom.
 
 todo: create some sort of tool for creating a TITLE_*.SYS file from a .SPR file
-and palette data. (or even better, a .png file, for people who aren't me!)
+and palette data. (blastar's NGFX can handle importing from BMP files)
 
 "See cdrom_load_title in cdrom.c of NEOCD 0.31":
 void cdrom_load_title(void)

doc/files.txt

@@ -5,7 +5,8 @@ Starting from the main folder:
 cdfiles\			Required Files for CD games
 doc\				Documentation
 examples\			Examples
-src\				Source Code
+src_68k\			Source Code (main)
+src_z80\			Source Code (sound)
 
 ================================================================================
 [cdfiles\]
@@ -118,8 +119,8 @@ The examples rely on being set up as they are in order to build correctly.
 (e.g. a path of "..\..\src\" from an example will go to the main src directory.)
 
 ================================================================================
-[src\]
-This directory contains the actual code and includes that make up the freemlib.
+[src_68k\ and src_z80\]
+These directories contain the actual code and includes that make up the freemlib.
 Trying to document it here would be pointless, as it will change often.
 
 ================================================================================

doc/functions/mess_macro.txt

@@ -1,6 +1,6 @@
 MESS_OUT Helpers
 ================
-Macros for more semantic use of MESS_OUT are found in src/inc/mess_macro.inc.
+Macros for more semantic use of MESS_OUT are found in src_68k/inc/mess_macro.inc.
 
 A reference is included here. Numbered values beginning with '\' are macro
 parameters; these get passed to the macro.

doc/usage.txt

@@ -13,23 +13,23 @@ your environment so you can actually use the freemlib in the first place.
 Files to Copy (or Symlink) and Leave Alone
 ------------------------------------------
 (Addresses, Registers)
-* src/inc/input.inc				Defines for Controller inputs.
-* src/inc/mvs_bram.inc			Defines for MVS Backup RAM.
-* src/inc/neogeo.inc			Defines for Neo-Geo hardware.
-* src/inc/ram_bios.inc			Defines for the BIOS RAM locations.
+* src_68k/inc/input.inc			Defines for Controller inputs.
+* src_68k/inc/mvs_bram.inc		Defines for MVS Backup RAM.
+* src_68k/inc/neogeo.inc		Defines for Neo-Geo hardware.
+* src_68k/inc/ram_bios.inc		Defines for the BIOS RAM locations.
 
 (freemlib Functionality)
-* src/inc/mess_macro.inc		Macros for use with MESS_OUT.
-* src/inc/mess_defs.inc			Defines for characters to use with MESS_OUT.
+* src_68k/inc/mess_macro.inc	Macros for use with MESS_OUT.
+* src_68k/inc/mess_defs.inc		Defines for characters to use with MESS_OUT.
 --------------------------------
-* src/func/animation.asm		Animation-related functions.
-* src/func/background.asm		Background-related functions.
-* src/func/collision.asm		Collision-related functions.
-* src/func/fix.asm				Fix layer-related functions.
-* src/func/memcard.asm			Memory Card-related functions.
-* src/func/palette.asm			Palette-related functions.
-* src/func/sprites.asm			Sprite-related functions.
-* src/func/system.asm			System-related functions.
+* src_68k/func/animation.asm	Animation-related functions.
+* src_68k/func/background.asm	Background-related functions.
+* src_68k/func/collision.asm	Collision-related functions.
+* src_68k/func/fix.asm			Fix layer-related functions.
+* src_68k/func/memcard.asm		Memory Card-related functions.
+* src_68k/func/palette.asm		Palette-related functions.
+* src_68k/func/sprites.asm		Sprite-related functions.
+* src_68k/func/system.asm		System-related functions.
 
 (CD System-specific Files)
 * cdfiles/ABS.TXT				Abstract file with required data for loading.
@@ -38,10 +38,10 @@ Files to Copy (or Symlink) and Leave Alone
 
 Files to Copy and Change
 ------------------------
-* src/header_68k.inc			68000 Vectors and such at $0.
-* src/header_cart.inc			Neo-Geo program header for Cart systems at $100.
-* src/header_cd.inc				Neo-Geo program header for CD systems at $100.
-* src/ram_user.inc				User RAM defines.
+* src_68k/header_68k.inc		68000 Vectors and such at $0.
+* src_68k/header_cart.inc		Neo-Geo program header for Cart systems at $100.
+* src_68k/header_cd.inc			Neo-Geo program header for CD systems at $100.
+* src_68k/ram_user.inc			User RAM defines.
 
 header_68k.inc
 --------------