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

add linux build instructions to README.md #998

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

Conversation

aszarth
Copy link

@aszarth aszarth commented Oct 7, 2024

Added instructions on how to build on Linux.
Also included information about sub module folders for users who don't use the --recursive option, so they can manually check and download them.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

README.md Outdated
@@ -46,6 +46,10 @@ git clone --recursive [email protected]:openmultiplayer/open.mp

Note the use of the `--recursive` argument, because this repository contains submodules.

If you don't use this parameter, you will need to download the files manually and place them in their respective folders, or you will encounter errors during the build process.
Copy link
Member

Choose a reason for hiding this comment

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

this git repository contains git submodules
if they don't know how to use git then it's not really our problem, we shouldn't even mention this method of retrieving submodules, because then it's not going to be the right revision

Copy link
Author

Choose a reason for hiding this comment

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

this git repository contains git submodules if they don't know how to use git then it's not really our problem, we shouldn't even mention this method of retrieving submodules, because then it's not going to be the right revision

It is not about know how to use git, the command above shows how to download with sub modules...
I just wanted to make life easier to people who don't like to use this parameter and want to download manually, but you are right, if dependencies change we will need to change on README.md too, so i'll remove this part...

@aszarth aszarth force-pushed the add-linux-build-tutorial branch from 12b33c8 to ca39149 Compare October 7, 2024 16:37
@aszarth aszarth requested a review from AmyrAhmady October 7, 2024 18:06
@AmyrAhmady
Copy link
Member

Also one more question, why are you encouraging to use docker manually and directly when there's a build.sh script file for anyone to use easily, without requiring them to switch between different ubuntu version folders, also able to set some configurations

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.

3 participants