Skip to content

Commit 89697eb

Browse files
committed
Update README.md
1 parent 242a037 commit 89697eb

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1+
# Using this Template
2+
3+
Bootstrap it:
4+
5+
```
6+
mkdir -p ~/src/boxen/puppet-mynewmodule
7+
cd ~/src/boxen/puppet-mynewmodule
8+
git init .
9+
git remote add template https://github.com/boxen/puppet-template.git
10+
git fetch template
11+
git co -b master template/master
12+
```
13+
14+
Now we're ready to make it our own!
15+
16+
```
17+
script/cibuild
18+
.bundle/binstubs/rspec-puppet-init
19+
```
20+
21+
Now you'll need to edit `manifests/init.pp` and `spec/classes/template_spec.rb`
22+
for your module.
23+
If your module has other dependencies, be sure to update
24+
`spec/fixtures/Puppetfile`.
25+
From then on, you can use `script/cibuild` to run the tests.
26+
27+
When you're ready to push:
28+
29+
```
30+
git create githubusername/puppet-mynewmodule
31+
git push origin master
32+
```
33+
34+
The rest of the README as follows can be used as a template for your module's README.
35+
136
# Template Puppet Module for Boxen
237

338
An example of how we write Puppet modules for Boxen. Replace this

0 commit comments

Comments
 (0)