This repository has been archived by the owner on Mar 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 283
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1313 from gubatron/note-for-golang-newbies
[docs] Note for new golang hackers
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
|
@@ -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 | ||
``` |