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

README.me should say export ARCH=Linux before running build? #23

Open
marcmerlin opened this issue Jan 3, 2021 · 4 comments
Open

README.me should say export ARCH=Linux before running build? #23

marcmerlin opened this issue Jan 3, 2021 · 4 comments

Comments

@marcmerlin
Copy link

By default it says unsupported platform, build.sh doesn't try to run uname -o or anything

If the intent is to set ARCH manually, can you add this in README?

@umarcor
Copy link
Collaborator

umarcor commented Jan 3, 2021

You are correct. ARCH is expected to be set, and there is no feedback about it. In CI, it is set as https://github.com/im-tomu/fomu-toolchain/blob/master/.github/workflows/update.yml#L66-L70. I think it'd be desirable to enhance the error message (https://github.com/im-tomu/fomu-toolchain/blob/master/build.sh#L133-L134). Say Unrecognized platform ARCH=${ARCH} or tell it explicitly: "you should set envvar ARCH".

In the readme, instead of suggesting users to build the toolchain themselves, IMHO we should update the first sentence of Usage. Instead of linking to the latest stable release, we should link to nightly releases and suggest using the latest stable as a fallback only.

@marcmerlin, are you up to proposing a PR? I'm not a native english speaker, but I can review/help with technical details.

@mithro
Copy link
Member

mithro commented Jan 4, 2021

Any reason to not "autodetect" it if not provided?

@mithro
Copy link
Member

mithro commented Jan 4, 2021

@marcmerlin
Copy link
Author

Yeah, Tim's answer is kind of what I had in mind. If not, just stating in the README that the user is supposed to set this, would be enough otherwise.

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

No branches or pull requests

3 participants