ref: 0da1489da153948aafbd55d3240d6bdddb8c91a7
parent: 2fa9a3c7683ff45119307554fa71d268039cca3c
author: bentley <[email protected]>
date: Sat Apr 3 15:43:03 EDT 2010
replace readme with installation instructions
--- a/README
+++ b/README
@@ -1,33 +1,36 @@
-RGBDS-linux
-
-Copyright (C) 1997 Carsten Sorensen <[email protected]>
-Copyright (C) 1999 Justin Lloyd <[email protected]> (?)
-Copyright (C) 2009 Vegard Nossum <[email protected]>
-
+----------------
+ RGBDS README
+----------------
-What is RGBDS-linux?
-====================
+RGBDS (Rednex Game Boy Development System) is a free assembler/linker package
+for the Game Boy and Game Boy Color. It consists of:
-RGBDS-linux is a revival of the "Rednex GameBoy Development System" (RGBDS),
-a set of tools that allow you to compile your own games and programs for the
-Nintendo GameBoy.
+ - rgbasm (assembler)
+ - rgblink (linker)
+ - rgblib (library manager)
+ - rgbfix (checksum/header fixer)
-RGBDS consists of an assembler (rgbdasm), a linker (xlink), a library manager
-(xlib), and a tool for producing valid GameBoy ROM images (rgbfix).
+rgbds-linux is a fork of the original RGBDS which aims to make the programs
+more like other UNIX tools.
-I _think_ this is the development history of RGBDS/ASMotor:
- * Around 1997, Carsten Sorensen (AKA SurfSmurf) writes ASMotor as a
- general-purpose assembler/linker system for DOS/Win32
-
- * Around 1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to
- read and produce Z80 assembly/machine code, and releases this
- version as RGBDS.
+ Building RGBDS
+================
-This (RGBDS-linux) is an adaption of RGBDS intended for use on GNU/Linux
-systems. In short, we provide a project layout and user interface that is more
-familiar to GNU/Linux users. Note that we make no attempt to retain backwards
-compatibility with the original RGBDS, or even the possibility to run the
-programs on DOS/Win32.
+To build the programs on a UNIX or UNIX-like system, just run in your terminal:
-Also expect improvements and bugfixes to make their way into the source code.
+ make
+
+There is no install target -- just copy the binaries (rgbasm, rgbfix, rgblib,
+and rgblink) to a folder in your $PATH.
+
+To build the documentation, use the man target:
+
+ make man
+
+This will create manual pages (rgbasm.0, rgbfix.0, rgblib.0, and rgblink.0)
+which can be read with a pager such as more(1):
+
+ more rgbasm.0
+
+There are no Windows installation instructions at this time.