Commit Graph

59 Commits

Author SHA1 Message Date
Josh Soref b68168807a Miscellaneous doc improvements
backticks, spaces, commas

In general, a list of items should have a space after each comma.
While there are editorial styles that suggest commas inside quotations,
they're horrible advice when the backticks are describing specific
character for a user to enter.

one off indent filters section

singular

backticks...

word wrap long lines...

spelling: macOS

contributing: clarify closing case
contributing: link to changelog
contributing: point to git remote...
contributing: split commands from descriptions
contributing: grammar
spelling: github
grammar: comma after etc.
spelling: macOS
grammar: i.e.
alicloud: use relative link
alicloud: use backticks
alicloud: bits
alicloud: such as
grammar: comma after etc.
avoid linking periods
grammar: period
amazon-chroot: IOPS
amazon-chroot: use backticks
amazon-chroot: link to section
amazon-chroot: whether-or-not; period
amazon-ebs: period
amazon-ebs: use relative link
amazon-ebs: use backticks
amazon-ebs: comma
amazon-ebs: bold
amazon-ebssurrogate: comma after etc.
amazon-ebssurrogate: this builder
amazon-instance: this builder
amazon-ebssurrogate: set this
amazon-ebssurrogate: whether-or-not
amazon-ebssurrogate: period
amazon-ebssurrogate: bold section reference
amazon-ebssurrogate: backticks...
amazon-ebssurrogate: commas around e.g.
spelling: precedence
spelling: i.e.
amazon-ebssurrogate: backticks...
2018-10-18 19:09:49 -04:00
DanHam 6c6716fe16
Remove `go get` from Quick Start as this isn't required to use Packer 2018-06-17 03:05:30 +01:00
Matthew Hooker bc5cf25d69
update github link to point to hashicorp 2018-04-02 20:09:32 -07:00
Matthew Hooker 70426af4eb
update contributing link 2018-04-02 10:59:59 -07:00
Matthew Hooker ce04476931
update contributing link 2018-04-02 10:55:16 -07:00
Matthew Hooker 7ede3296cf
remove plugin listing from readme 2018-02-16 12:06:06 -08:00
Edouard BONLIEU e46108298c
Update README.md 2018-02-08 12:09:25 -08:00
Matthew Hooker 449da83896
use correct oracle builder name 2017-10-23 12:10:31 -07:00
Andrew Pryde 9728f890cf Implemented and documented oracle-bmcs builder
Implements a new Packer builder (oracle-bmcs) which adds support for
building custom images for Oracle Bare Metal Cloud Services (BMCS)
https://cloud.oracle.com/en_US/bare-metal.

Additionally includes documentation for the oracle-bmcs builder.
2017-08-02 09:53:48 +01:00
Darío Hereñú 43784c7db0 Minor fixes 2017-06-22 00:35:55 -03:00
Matthew Hooker 8423a0f2cd
fix appveyor 2017-06-06 11:52:21 -07:00
Luke Farnell 80eadc3bcf Fixed readme.md and contributing.md 2017-04-08 17:11:23 -04:00
Matthew Hooker 81522dced0
move packer to hashicorp 2017-04-04 13:39:01 -07:00
Matthew Hooker 5134d750ca
update readme with supported providers 2017-03-22 12:08:47 -07:00
Anton Kvashenkin 5ba75fff16 README: update packer website url with HTTPS 2017-03-12 13:04:18 +03:00
Matthew Hooker cdfe7fb6fc
fix ami 2017-02-21 10:53:32 -08:00
Matthew Hooker bbe846443f
use t2. instance type in readme 2017-02-09 23:22:31 -08:00
Rickard von Essen d6892442a8 Merge pull request #4037 from dacamp/readme
Badge updates and go get
2016-12-26 15:01:10 +01:00
Jeff Geerling 8ca9f633d3 Fixes #4081: Fix broken README link for 'compile Packer yourself'. 2016-10-27 22:31:57 -05:00
David Campbell 64299cfd4e Badge updates and go get
- `godoc` and `goreportcard`
- package installation
2016-10-21 04:03:50 -07:00
Christopher Boumenot cab750abb1 Add Azure to the list of supported platforms 2016-06-15 10:28:32 -07:00
Thomas Vendetta af3bc4f12b Fix README build example to work out of box.
- secret_key was set to use the access_key env variable
2016-03-16 22:16:35 -04:00
Chris Bednarski f5777bca7b Moved the bulk of go setup to CONTRIBUTING.md so it doesn't need to be maintained in two places 2016-02-05 14:21:10 -08:00
Tyler Tidman 79b8f0014b Add a few build setup instructions to the readme 2016-02-03 11:06:34 -05:00
Asfand Yar Qazi eaa088b491 README.md quick-start builder example made more secure
Adding credentials to a file that may get committed to
a git repository is dangerous; make the example follow
best practices and pull the AWS credentials out of
the environment
2015-12-15 22:33:19 +00:00
Emil Hessman eef260a11b Add AppVeyor status badge to README 2015-06-29 19:23:44 +02:00
Mitchell Hashimoto 7bbb940896 update README 2015-05-29 08:37:41 -07:00
Mitchell Hashimoto 4ea821737a update README for acceptance tests 2015-05-26 13:50:45 -07:00
Yuya Kusakabe f8d50a9749 Add Travis CI badge to README 2015-01-23 11:58:23 +09:00
Mitchell Hashimoto 2788ccc653 Update scripts to latest HashiCorp style 2014-09-02 15:13:55 -07:00
Ross Smith II 77d4c346af Update README.md
Added other supported platforms
2014-05-09 07:37:34 -07:00
Mitchell Hashimoto ec30d574c1 Update README [GH-1009] 2014-04-26 15:10:33 -07:00
Sudharshan S c4942a62ee The minimum go version to build packer is 1.2, not 1.1.
Change the documentation accordingly. 'ne' template function was added as part of go 1.2.
http://golang.org/doc/go1.2#text_template
2013-12-16 18:50:57 +05:30
Kyle Conroy 0a40b905ad Point gox link to correct repository 2013-11-30 00:01:18 -08:00
Mitchell Hashimoto dbe54678f6 Merge pull request #650 from mitchellh/readme-gox
readme: add a note about the gox dependency for compiling
2013-11-22 08:41:50 -08:00
Matthew Hooker 37466e5a68 README/developing packer
Mention the bazaar requirement.

https://launchpad.net/tomb is the only package which uses bazaar so far.
2013-11-22 03:17:16 -08:00
Jack Pearkes c1c33b4e22 readme: add a note about the gox dependency for compiling
I thought about putting it in compile.sh or devcompile.sh, but then
I realized if gox changes upstream it will be buried and potentially
confusing to update. Hence including the `-u` in the readme for
`go get`.
2013-11-22 11:31:02 +01:00
Prasanna Santhanam 826c230a40 Update README.md to include updatedeps target
When new dependencies are included builds on your localrepo will fail
until you have all the latest dependencies in the GOPATH. After doing
updatedeps, make will generate the packer binary.

Signed-off-by: Prasanna Santhanam <tsp@apache.org>
2013-11-07 18:48:01 +05:30
Mitchell Hashimoto e5350ce573 Update README 2013-09-03 08:53:29 -07:00
Marc Weistroff 6ebfbd27ab Add make format information in the contributing guidelines. 2013-09-03 14:58:32 +02:00
Mitchell Hashimoto c5e5237767 README: move CreateTime to timestmap 2013-08-08 17:25:26 -07:00
Emil Sit e65ab8e93c README: Clarify repository placement relative to GOPATH
If you don't put the repository in the right place in GOPATH,
changes to your sources don't get built.

Signed-off-by: Emil Sit <sit@emilsit.net>
2013-07-04 23:59:52 -04:00
Mitchell Hashimoto cc9f309275 Update README 2013-06-30 21:03:24 -07:00
Mark Jaquith fff8d3a5b3 Note that Mercurial (hg) is a dependency for developing on Packer. 2013-06-30 22:46:22 -04:00
Mitchell Hashimoto 9ff1525fcd Update README to note GOPATH [GH-71] 2013-06-29 14:32:27 -07:00
Sergio Tapia Gutierrez 3d4f1c388c Add new paragraph to make readme easier to read. 2013-06-29 12:31:00 -04:00
Sergio Tapia Gutierrez ec4ee814bb Add a new paragraph to make it easier to read. 2013-06-29 12:29:17 -04:00
Sergio Tapia Gutierrez 319ff5d8ca Fix typo in README file. 2013-06-29 12:22:32 -04:00
Marc Abramowitz 272b31d989 Fix typo in README.md 2013-06-28 13:54:31 -07:00
Jack Pearkes 9dbab71121 readme: correct mentions of localhost to www.packer.io
cc/ @mitchellh
2013-06-28 17:27:38 +02:00