Skip to content

Add install instructions to readme#6

Open
lomnom wants to merge 1 commit intocwesson:masterfrom
lomnom:patch-1
Open

Add install instructions to readme#6
lomnom wants to merge 1 commit intocwesson:masterfrom
lomnom:patch-1

Conversation

@lomnom
Copy link

@lomnom lomnom commented Nov 3, 2025

This pull request adds explicit installation instructions to the README to improve the onboarding experience for new users.

While this project is a great and comprehensive Funge interpreter, the installation process was not straightforward for newcomers. Previously, users needed to inspect the source code and do trial and error to get the tool running. The new instructions make setup simpler.

The commands have been tested on Ubuntu 20.04.

Installation instructions should be added directly to the readme to reduce the frustration that new users may face.
## Installation
These instructions have been tested on Ubuntu 20.

1. Clone with `git clone --recursive https://github.com/cwesson/funge-plus-plus.git`
Copy link
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

These instructions have been tested on Ubuntu 20.

1. Clone with `git clone --recursive https://github.com/cwesson/funge-plus-plus.git`
2. Ensure make, cmake and g++ are installed. On ubuntu this can be done with `sudo apt install make cmake g++`.
Copy link
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants