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

Provide more complete installation instructions #2775

Open
5 tasks
kopeboy opened this issue Oct 26, 2023 · 2 comments
Open
5 tasks

Provide more complete installation instructions #2775

kopeboy opened this issue Oct 26, 2023 · 2 comments
Labels
admin: epic An EPIC -- meta issue used to track a body of work type: feature-request New feature or request improvement

Comments

@kopeboy
Copy link

kopeboy commented Oct 26, 2023

Summary

Two problems:

  1. If you have a newer go version, make install will fail with ERROR: Go version 1.20 is required for v13.0.1 of Gaia.
    I tried downloading & installing go1.20 (as an addition to my go1.21.3) but then I don't know how to tell gaia to use that.

  2. If you try by downloading the binary for macOS (darwin arm64) then the os doesn't know how to open it and no instructions are given. May it be a missing file extension? I don't know, I'm a noob.

Problem Definition

Non-expert developers and just users might want to use the gaia daemon CLI to interact with the chain, since no GUI wallet provides interfaces for all the features, hence more ELI5 are needed imho.

Proposal

Improve intallation documentation for common platforms like macOS and Windows by providing solution instructions to common errors like those I just encountered.

Thank you


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
  • Is a spike necessary to map out how the issue should be approached?
@kopeboy kopeboy added type: feature-request New feature or request improvement admin: epic An EPIC -- meta issue used to track a body of work status: waiting-triage This issue/PR has not yet been triaged by the team. labels Oct 26, 2023
@kopeboy
Copy link
Author

kopeboy commented Oct 26, 2023

(Note for other noobs: you can download the Source code archive, zip or tar.gz, and just open that)

@mmulji-ic
Copy link
Contributor

mmulji-ic commented Oct 31, 2023

Hi @kopeboy thanks for reporting this issue.

Regarding item 1:
I've updated the release details - which were missing this information, usually the go version should be included as well, as its quite important for the good functioning of the network - thats why we mandate it here in the makefile.

Other onboarding/getting started docs should also have this information. Go usually works on a system level rather than via simple configuration. So you need to install the correct version of go or use docker with the go version that you want to use to compile the source code if you do not want to make system level changes just for one application.

Regarding item 2:
Typically, MacOS/Linux binaries do not have extensions. If your making from source you should be able to run the application directly.

We can expand installation instructions as part of this issue as well.

@mmulji-ic mmulji-ic removed the status: waiting-triage This issue/PR has not yet been triaged by the team. label Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin: epic An EPIC -- meta issue used to track a body of work type: feature-request New feature or request improvement
Projects
Status: 🤔 F1: Investigate
Development

No branches or pull requests

2 participants