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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions setup.md
Original file line number Diff line number Diff line change
@@ -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

=============
```bash
git clone --recurse-submodules [email protected]:gtfierro/hoddb.git
cd hoddb
```

Install go
==========
* [Install go](https://golang.org/doc/install)
* source setup.sh:
```bash
. /setup.sh
Comment on lines +11 to +13
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

```

You should now be able to run:
```bash
make proto
make build
make test
make run
```

6 changes: 6 additions & 0 deletions setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export PATH=$PATH:/usr/local/go/bin
# the following will place three binaries in your $GOBIN ($HOME/go/bin)
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
go get -u github.com/golang/protobuf/protoc-gen-go
export PATH=$PATH:$HOME/go/bin