Skip to content

Update README.md #760

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

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

Conversation

B-Interactive
Copy link

Added Arch Linux make and install instructions. Dependencies are automatically installed in this process, so it was a little tricky to decide where to place this.

Added Arch Linux make and install instructions.  Dependencies are automatically installed in this process.
@yuxiaomao
Copy link
Collaborator

I'm not familiar with Arch Linux, but what you've provide does not seems to be a build from source (git latest) instruction, and can be confusing if placed in README.
If you think it's very important for Arch Linux user, I suggest you to put it into the wiki: https://github.com/HaxeFoundation/hashlink/wiki/Building-and-Installing#how-to-install

@B-Interactive
Copy link
Author

B-Interactive commented Mar 11, 2025

It would be building from source (pulling from https://github.com/HaxeFoundation/hashlink/archive/${pkgver}.tar.gz which would currently represent release 1.14).

This is the Arch way of things. One does not build from source independent of the package management system, one leverages the package management system to build from source. The PKGBUILD file for this package shows where the source is pulled from, and how it is built (make) and installed, as well as any dependencies that will be installed with it.

If the README.md is for how to build against the latest commit, then a simple adjustment to installing hashlink-git (latest commit) instead of hashlink (latest release) is all that is needed.

I don't mean to wrestle this change in though. I simply offered it for the sake of thoroughness, and as the package maintainer for hashlink-git and fond user of Haxe.

@tobil4sk
Copy link
Member

One does not build from source independent of the package management system, one leverages the package management system to build from source.

The instructions in the README are intended for people who have downloaded the sources for the purpose of building them directly, for example if you're working on changes to hashlink.

That being said, platform specific instructions like this are useful and should have a place, though I would agree the wiki should be that place (otherwise it gets unwieldy). It could be linked from the README to be more discoverable for users who are just looking to install hashlink on their system rather than building from source.

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