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

[docs] Note for new golang hackers #1313

Merged
merged 2 commits into from
Feb 27, 2019
Merged

[docs] Note for new golang hackers #1313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b6d198
[docs] Note for new golang hackers
gubatron Nov 27, 2018
8cff96b
Merge branch 'master' into note-for-golang-newbies
hoffmabc Feb 27, 2019
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
15 changes: 15 additions & 0 deletions docs/install-linux.md
View file
Open in desktop
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
View file
Open in desktop
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
```