forked from apptio/kr8
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes on the documentation to make the links on README.md work agai…
…n to fix: apptio#22
- Loading branch information
jdelarosaescobedo
committed
Apr 2, 2020
1 parent
e94d111
commit c183865
Showing
2 changed files
with
40 additions
and
5 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
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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
#Building kr8 | ||
|
||
As mentioned before, kr8 is coded in [Golang](https://golang.org/) so after following the next steps you should be able to use the kr8 binary like this: | ||
|
||
`./kr8 --help` | ||
|
||
##Prerequisites | ||
|
||
1. Install and configure Go: https://golang.org/doc/install | ||
|
||
2. Get familiar with Golang: https://golang.org/doc/ | ||
|
||
3. If you are fully testing the build you need to install: https://github.com/go-task/task | ||
|
||
---- | ||
|
||
##Building the executable | ||
|
||
On the project root: | ||
|
||
`go build` | ||
|
||
Go will start downloading the dependencies to create the executable, then you will end up with the following file: | ||
|
||
`-rwxr-xr-x 1 myuser mygroup 23M Apr 2 12:44 kr8` | ||
|
||
Where "23M" is the current size of the executable. | ||
|
||
##Troubleshooting the process | ||
|
||
1. Dependencies download fail: | ||
There is a big number of reasons this could fail but the most important might be: | ||
-Networking problems: Check your connection to: github.com, golang.org and k8s.io. | ||
-Disk space: If no space is available on the disk, this step might fail. | ||
|
||
2. go build does not start the build: | ||
Confirm you are in the correct project directory. | ||
|
||
---- |