From 37f4f47aa8e6ee7fad2e27d3775009bafa24177f Mon Sep 17 00:00:00 2001 From: yenatch Date: Sun, 8 Dec 2013 16:02:25 -0500 Subject: add INSTALL.md and README -> README.md --- INSTALL.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 INSTALL.md (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..b811a770 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,55 @@ +# Getting Started + +A base rom of Pokémon Red is required to assemble **pokered.gbc**. + + Pokemon Red (UE) [S][!].gb + (MD5: 3d45c1ee9abd5738df46d2bdda8b57dc) + + +# Linux + + sudo apt-get install make gcc bison git python python-setuptools + sudo easy_install pip + +Install rgbds, a Game Boy ROM assembler. + + git clone git://github.com/bentley/rgbds.git + cd rgbds + make + sudo make install + + cd .. + +Set up the pokered repository. + + git clone git://github.com/iimarckus/pokered.git + cd pokered + + git submodule init + git submodule update + + cd extras + pip install -r requirements.txt + cd .. + +Put your base rom in the pokered repository. Name it "baserom.gbc". + + make red + +This should take about 10-15 seconds. Subsequent compiles are faster. + + +To build Pokémon Blue: + + make blue + + +# OSX + +Download and install Xcode. Then follow the Linux instructions. + + +# Windows + +Not yet. + -- cgit v1.3.1-sl0p From 20c01389cc8b5cbea59796ee0825fcd877c15fef Mon Sep 17 00:00:00 2001 From: yenatch Date: Sun, 8 Dec 2013 20:13:10 -0500 Subject: clearer install instructions --- INSTALL.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index b811a770..bcba15d1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,10 +8,11 @@ A base rom of Pokémon Red is required to assemble **pokered.gbc**. # Linux +Linux dependencies. OSX users already have these after installing Xcode. + sudo apt-get install make gcc bison git python python-setuptools - sudo easy_install pip -Install rgbds, a Game Boy ROM assembler. +Install **rgbds**, a Game Boy assembler: git clone git://github.com/bentley/rgbds.git cd rgbds @@ -20,7 +21,7 @@ Install rgbds, a Game Boy ROM assembler. cd .. -Set up the pokered repository. +Set up the pokered repository: git clone git://github.com/iimarckus/pokered.git cd pokered @@ -28,15 +29,14 @@ Set up the pokered repository. git submodule init git submodule update - cd extras - pip install -r requirements.txt - cd .. + sudo easy_install pip + pip install -r extras/requirements.txt Put your base rom in the pokered repository. Name it "baserom.gbc". make red -This should take about 10-15 seconds. Subsequent compiles are faster. +This should take about 10-15 seconds. Subsequent builds are faster. To build Pokémon Blue: @@ -46,7 +46,7 @@ To build Pokémon Blue: # OSX -Download and install Xcode. Then follow the Linux instructions. +Download and install **Xcode**. Then follow the Linux instructions. # Windows -- cgit v1.3.1-sl0p From 81c6bed27d4251c90ebff8475398c69e22781966 Mon Sep 17 00:00:00 2001 From: yenatch Date: Sun, 8 Dec 2013 21:40:18 -0500 Subject: init.sh for lazy installs --- INSTALL.md | 18 ++++-------------- init.sh | 16 ++++++++++++++++ 2 files changed, 20 insertions(+), 14 deletions(-) create mode 100755 init.sh (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index bcba15d1..d687288c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -12,27 +12,17 @@ Linux dependencies. OSX users already have these after installing Xcode. sudo apt-get install make gcc bison git python python-setuptools -Install **rgbds**, a Game Boy assembler: - git clone git://github.com/bentley/rgbds.git - cd rgbds - make - sudo make install - - cd .. - -Set up the pokered repository: +Set up the **pokered** repository: git clone git://github.com/iimarckus/pokered.git cd pokered - git submodule init - git submodule update + ./init.sh - sudo easy_install pip - pip install -r extras/requirements.txt +Copy the Pokémon Red rom to this directory. Name it **baserom.gbc**. -Put your base rom in the pokered repository. Name it "baserom.gbc". +Now **pokered.gbc** can be built from source. make red diff --git a/init.sh b/init.sh new file mode 100755 index 00000000..a0cc1ccd --- /dev/null +++ b/init.sh @@ -0,0 +1,16 @@ +#!/bin/sh + +# install rgbds +git clone git://github.com/bentley/rgbds.git && \ +cd rgbds && \ +make && \ +sudo make install && \ +cd .. && \ +rm -rf rgbds + +# set up the submodule (extras/) +git submodule init && \ +git submodule update && \ +sudo easy_install pip && \ +pip install -r extras/requirements.txt + -- cgit v1.3.1-sl0p