This repository has been archived by the owner on May 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix code indenting and coloring in getting started
- Loading branch information
1 parent
445234d
commit 44a280c
Showing
1 changed file
with
25 additions
and
37 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 |
---|---|---|
|
@@ -6,50 +6,38 @@ Duffle is a command line tool that allows you to install and manage CNAB bundles | |
## Getting Started | ||
|
||
1. Ensure you're running the latest version of Go (1.11+) by running `$ go version` | ||
```console | ||
$ go version | ||
go version go1.11 darwin/amd64 | ||
``` | ||
```console | ||
$ go version | ||
go version go1.11 darwin/amd64 | ||
``` | ||
|
||
2. Clone this repo: | ||
```console | ||
$ cd $GOPATH/src/github.com/deis/ | ||
$ git clone [email protected]:deis/duffle.git | ||
$ cd duffle | ||
``` | ||
``` | ||
cd $GOPATH/src/github.com/deis/ | ||
git clone [email protected]:deis/duffle.git | ||
cd duffle | ||
``` | ||
|
||
3. Vendor dependencies and build the `duffle` binary: | ||
``` | ||
$ make bootstrap build | ||
``` | ||
``` | ||
make bootstrap build | ||
``` | ||
|
||
4. Run the command to set duffle up on your machine: | ||
```console | ||
$ duffle init | ||
The following new directories will be created: | ||
/Users/janedoe/.duffle | ||
/Users/janedoe/.duffle/logs | ||
/Users/janedoe/.duffle/plugins | ||
/Users/janedoe/.duffle/repositories | ||
/Users/janedoe/.duffle/claims | ||
/Users/janedoe/.duffle/credentials | ||
==> Installing default repositories... | ||
==> repo added in 1.096263107s | ||
``` | ||
```console | ||
$ duffle init | ||
The following new directories will be created: | ||
/Users/janedoe/.duffle | ||
/Users/janedoe/.duffle/logs | ||
/Users/janedoe/.duffle/plugins | ||
/Users/janedoe/.duffle/repositories | ||
/Users/janedoe/.duffle/claims | ||
/Users/janedoe/.duffle/credentials | ||
==> Installing default repositories... | ||
==> repo added in 1.096263107s | ||
``` | ||
|
||
5. Search for available bundles: | ||
```console | ||
$ duffle search | ||
NAME REPOSITORY VERSION | ||
helloazure github.com/deis/bundles.git 0.1.0 | ||
hellohelm github.com/deis/bundles.git 0.1.0 | ||
helloworld github.com/deis/bundles.git 1.0 | ||
``` | ||
*Notes:* | ||
* These bundles are hosted in the [bundles repo](https://github.com/deis/bundles) on github. There is ongoing work on the bundle repository design and to support http based repositories much of which you can see via [this pull request](https://github.com/deis/duffle/pull/184). | ||
* Learn more about what a bundle is and its components [here](https://github.com/deis/duffle/blob/master/docs/100-CNAB.md). | ||
* Get a feel for what CNAB bundles look like by referencing the [examples](examples/) directory. | ||
|
||
```console | ||
$ duffle search | ||
NAME REPOSITORY VERSION | ||
|
@@ -87,4 +75,4 @@ helloworld github.com/deis/bundles.git 1.0 | |
``` | ||
|
||
# Debugging using VS Code | ||
For instructions on using VS Code to debug the Duffle binary, see [the debugging document][docs/001-debugging.md]. | ||
For instructions on using VS Code to debug the Duffle binary, see [the debugging document][docs/001-debugging.md]. |