Skip to content

Add install instructions to readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lomnom wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add install instructions to readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add install instructions 
Installation instructions should be added directly to the readme to reduce the frustration that new users may face.
  • Loading branch information
@lomnom
lomnom authored Nov 3, 2025
commit 81b40ae5484eba9a15ca5508292eddf8e50948a0
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ Funge++ is Befunge interpreter originally written by Conlan Wesson in Java for a
with minimal functionality. It has since been converted to C++, supports all Funge-98 instructions and N-dimensional
Funge. The Funge++ handprint is 0x464E2B2B (`FN++`).

## Installation
These instructions have been tested on Ubuntu 20.

1. Clone with `git clone --recursive https://github.com/cwesson/funge-plus-plus.git`

@cwesson cwesson Nov 9, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one submodule as well, probably should add git submodule update --init

2. Ensure make, cmake and g++ are installed. On ubuntu this can be done with `sudo apt install make cmake g++`.

@cwesson cwesson Nov 9, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cmake is not needed

3. Run `make build` in the `funge-plus-plus` directory.

After completion, the executable is produced in `funge-plus-plus/bin/funge`. It can be run from the `funge-plus-plus`
directory as `bin/funge [befunge file to run]`.

## Running
The Funge++ executable `funge` uses the first file argument to load the funge program. The first character of the
file is an instruction at (0,0). Each subsequent character is an instruction at X+1. Both carriage returns and
Expand Down Expand Up @@ -127,4 +137,4 @@ Instructions from dynamic Funges run with the same stack as the IP that called t
## Debugger
The Funge++ debugger, known as defunge, can be run on any Befunge program by specifying the `-g` command line argument.

See [Defunge](doc/defunge.md) for details.
See [Defunge](doc/defunge.md) for details.