Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1313 from gubatron/note-for-golang-newbies
Browse files Browse the repository at this point in the history
[docs] Note for new golang hackers
  • Loading branch information
cpacia authored Feb 27, 2019
2 parents 1af705f + 8cff96b commit 5513cba
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/install-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,18 @@ To compile and run the source:
cd $GOPATH/src/github.com/OpenBazaar/openbazaar-go
go run openbazaard.go start
```

NOTE FOR NEW GOLANG HACKERS:

In most projects you usually perform a `git clone` of the repository in order to start hacking.

With `openbazaar-go` There's no need to manually `git clone` the project, this is done for you when you issue the `go get github.com/OpenBazaar/openbazaar-go` command, doing a manual `git clone` will only give you a repository that's missing a lot of recursive dependencies and building headaches.

If you are used to having all your other projects in some other place on disk, just make a symlink from `$GOPATH/src/github.com/OpenBazaar/openbazaar-go` into your usual workspace folder.

To start hacking and committing to your fork make sure to add your git remote into the `$GOPATH/src/github.com/OpenBazaar/openbazaar-go` folder with:

```
cd $GOPATH/src/github.com/OpenBazaar/openbazaar-go
git remote add myusername [email protected]:myusername/openbazaar-go.git
```
15 changes: 15 additions & 0 deletions docs/install-osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Checkout a copy of the source:
go get github.com/OpenBazaar/openbazaar-go
```


It will use git to checkout the source code into `$GOPATH/src/github.com/OpenBazaar/openbazaar-go`

Checkout a release version:
Expand All @@ -70,3 +71,17 @@ NOTE: If you have Xcode installed you may get the response `signal: killed`. If
```
go run --ldflags -s openbazaard.go start -t
```

NOTE FOR NEW GOLANG HACKERS:

In most projects you usually perform a `git clone` of the repository in order to start hacking.

With `openbazaar-go` There's no need to manually `git clone` the project, this is done for you when you issue the `go get github.com/OpenBazaar/openbazaar-go` command, doing a manual `git clone` will only give you a repository that's missing a lot of recursive dependencies and building headaches.

If you are used to having all your other projects in some other place on disk, just make a symlink from `$GOPATH/src/github.com/OpenBazaar/openbazaar-go` into your usual workspace folder.

To start hacking make sure to add your git remote into the `$GOPATH/src/github.com/OpenBazaar/openbazaar-go` folder with:
```
cd $GOPATH/src/github.com/OpenBazaar/openbazaar-go
git remote add myusername [email protected]:myusername/openbazaar-go.git
```

0 comments on commit 5513cba

Please sign in to comment.