Update README.md
This commit is contained in:
parent
242a037d43
commit
89697ebb74
1 changed files with 35 additions and 0 deletions
35
README.md
35
README.md
|
@ -1,3 +1,38 @@
|
|||
# Using this Template
|
||||
|
||||
Bootstrap it:
|
||||
|
||||
```
|
||||
mkdir -p ~/src/boxen/puppet-mynewmodule
|
||||
cd ~/src/boxen/puppet-mynewmodule
|
||||
git init .
|
||||
git remote add template https://github.com/boxen/puppet-template.git
|
||||
git fetch template
|
||||
git co -b master template/master
|
||||
```
|
||||
|
||||
Now we're ready to make it our own!
|
||||
|
||||
```
|
||||
script/cibuild
|
||||
.bundle/binstubs/rspec-puppet-init
|
||||
```
|
||||
|
||||
Now you'll need to edit `manifests/init.pp` and `spec/classes/template_spec.rb`
|
||||
for your module.
|
||||
If your module has other dependencies, be sure to update
|
||||
`spec/fixtures/Puppetfile`.
|
||||
From then on, you can use `script/cibuild` to run the tests.
|
||||
|
||||
When you're ready to push:
|
||||
|
||||
```
|
||||
git create githubusername/puppet-mynewmodule
|
||||
git push origin master
|
||||
```
|
||||
|
||||
The rest of the README as follows can be used as a template for your module's README.
|
||||
|
||||
# Template Puppet Module for Boxen
|
||||
|
||||
An example of how we write Puppet modules for Boxen. Replace this
|
||||
|
|
Loading…
Reference in a new issue