brainfu - File README.md

brainfu

Brain Fu Interpreter NES Game

[GIT] git clone git://vigrey.com/git/brainfu

Git Repositories

Commits

Refs

LICENSE

README

RSS Feed

README.md - (3400 Bytes)

 # Brain Fu Interpreter NES Cartridge
 
 A brainfu* interpreter written for NES cartridge to be played on real NES hardware.
 
 **_Brain Fu Interpreter NES Cartridge was created by Vi Grey and is licensed under the BSD 2-Clause License._**
 
 ### Description:
 This NES game is an interpreter for the brainfu* programming language, a esoteric Turing Complete programming language that uses only 8 instructions.  The standard NES controller is used to create and run programs using only the power of the NES hardware CPU.
 
 ### Platforms:
 - GNU/Linux
 
 ### Build Dependencies:
 - asm6 _(You'll probably have to build asm6 from source.  Make sure the asm6 binary is named **asm** and that the binary is executable and accessible in your PATH. The source code can be found at **http://3dscapture.com/NES/asm6.zip**)_
 - zip
 - gmake
 
 ### Build NES ROM:
 From a terminal, go to the the main directory of this project (the directory this README.md file exists in), you can then build the NES ROM with the following command.
 
     $ make
 
 The resulting NES ROM will be located at **bin/brainfu.nes**
 
 ### Cleaning Build Environment:
 If you used `make` to build the NES ROM, you can run the following command to clean up the build environment.
 
     $ make clean
 
 ### Controls:
 - A + Up: `+`
 - A + Down: `-`
 - A + Left: `<`
 - A + Right: `>`
 - B + Up: `.`
 - B + Down: `,`
 - B + Left: `[`
 - B + Right: `]`
 - Start: `Run`
 - Select: `Backspace`
 
 ### Specifications:
 - 1024 Byte Instruction Buffer _($0200-$05FF)_
 - 512 Byte Memory Tape _($0600-$07FF)_
 - 28 x 19 Print Screen Size _(7 bit ASCII Characters)_
 
 ### Extras:
 - #### Unzipping the ROM:
 
   The compiled NES ROM file at **bin/brainfu.nes** will also be a functioning ZIP file that contains its own source code when unzipped.
 
 - #### Identical EPROM data:
 
   This NES game is created in such a way that both the PRG and CHR EPROMs for an NROM-256 board contain the exact same data.  This means the PRG and CHR EPROMs can be swapped and the game will still function exactly the same.
 
 ### License:
     Copyright (C) 2018, Vi Grey
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions
     are met:
 
         1. Redistributions of source code must retain the above copyright
            notice, this list of conditions and the following disclaimer.
         2. Redistributions in binary form must reproduce the above copyright
            notice, this list of conditions and the following disclaimer in the
            documentation and/or other materials provided with the distribution.
 
     THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS \`\`AS IS'' AND
     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     SUCH DAMAGE.