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

A start for setup instructions #6

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

Conversation

HackerBaloo
Copy link

Perhaps it should be in the wiki instead
and I still need to figure out how to create a client. It is geared towards Linux, but I think it can be start.

@gtfierro
Copy link
Owner

Sorry I missed this notification somehow! Thanks so much for taking the time to put this together. I'll take a look at these instructions

Copy link
Owner

@gtfierro gtfierro left a comment

Choose a reason for hiding this comment

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

Great work and an important piece of documentation to have. If you address the changes I noted above then we should be able to merge this in soon

Comment on lines +11 to +13
* source setup.sh:
```bash
. /setup.sh
Copy link
Owner

Choose a reason for hiding this comment

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

If I remember correctly, dependencies should be taken care of by the existing Go tooling. Just run

$ go get
$ go build

from inside the project directory. I'd prefer to handle dependencies that way, as it is standard for most Go projects.

Also, the $PATH variable manipulation in setup.sh should be done as part of the Go installation process. I think this means we can get rid of setup.sh altogether

@@ -0,0 +1,23 @@
Initial setup
Copy link
Owner

Choose a reason for hiding this comment

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

Headers in Markdown are

# Initial Setup

Can we put the contents of setup.md into README.md under a ## Setup heading? I think it is best to have all of this in one location

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.

2 participants