Skip to content
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.

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

Installing and running instructions #1464

Merged
merged 2 commits into from
Jun 30, 2021
Merged

Installing and running instructions #1464

merged 2 commits into from
Jun 30, 2021

Conversation

Voklen
Copy link
Contributor

@Voklen Voklen commented Jun 20, 2021

This PR adds documentation on installing and running TIC-80 using the Linux build instructions.

The original docs didn't mention running sudo make install to install the program.make -j4 is executed while running sudo make install -j4 so the former is redundant and has been removed.The docs also didn't mention how to run the program after installation so those instructions have been added as well.

The make -j4 in the Mac build instructions could also be replaced with sudo make install -j4 but I don't have a MacOS machine to test it on so somebody else could try that.

Added help with installing and running to the Linux build instructions.
@RobLoach
Copy link
Contributor

RobLoach commented Jun 28, 2021

This is underneath "Build instructions", which would imply it's instructions how to build TIC-80, not install it. If you want install instructions, I would recommend adding a new section with make install.

Copy link
Owner

@nesbox nesbox left a comment

Choose a reason for hiding this comment

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

Hi,
pls move sudo make install to the Install section
Thank you for the help

@Voklen
Copy link
Contributor Author

Voklen commented Jun 29, 2021

I created an "Install instructions" section and a "Linux" sub-section to allow contributers to add install instructions for other platforms as well. I also added links to the section from the Linux build instructions.

Copy link
Owner

@nesbox nesbox left a comment

Choose a reason for hiding this comment

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

thank you

@nesbox nesbox merged commit fac3337 into nesbox:master Jun 30, 2021
@Voklen Voklen deleted the patch-1 branch June 30, 2021 17:06
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.

4 participants