Skip to content

Commit 19bf80d

Browse files
committed
A quick pass at updating the README.
1 parent fb12721 commit 19bf80d

1 file changed

Lines changed: 9 additions & 51 deletions

File tree

README.md

Lines changed: 9 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,13 @@
1-
# Using this Template
1+
# Puppet Module for qrencode
22

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 checkout -b master template/master
12-
```
13-
14-
Now edit the class name in `manifests/init.pp` and `spec/classes/template_spec.rb` to match the name of the module, without forgetting to rename `template_spec.rb` accordingly.
15-
16-
Now we're ready to make it our own and run a build!
17-
18-
```
19-
script/cibuild
20-
.bundle/binstubs/rspec-puppet-init
21-
```
22-
23-
Note that unless you have edited the class name and then run the above scripts, puppet-lint will fail during the cibuild with an error message similar to:
24-
25-
```
26-
--> Checking lint:
27-
manifests/init.pp - ERROR: template not in autoload module layout on line 2
28-
```
29-
30-
If your module has other dependencies, be sure to update
31-
`spec/fixtures/Puppetfile`.
32-
From then on, you can use `script/cibuild` to run the tests.
33-
34-
When you're ready to push:
35-
36-
```
37-
git create githubusername/puppet-mynewmodule
38-
git push origin master
39-
```
40-
41-
The rest of the README as follows can be used as a template for your module's README.
42-
43-
# Template Puppet Module for Boxen
44-
45-
An example of how we write Puppet modules for Boxen. Replace this
46-
paragraph with a short explanation of what the heck makes your module
47-
useful.
48-
49-
A great module has a working travis build
50-
51-
[![Build Status](https://travis-ci.org/boxen/puppet-template.svg?branch=master)](https://travis-ci.org/boxen/puppet-template)
3+
This is a simple module to install
4+
[qrenccode](http://fukuchi.org/works/qrencode/)
5+
via Homebew. It depends on
6+
[libpng](http://sourceforge.net/projects/libpng/) which I discovered moves
7+
their release tarballs around (e.g., into "old" directories), which can be
8+
hard to build. You may need to `brew update` to have a more up-to-date
9+
Homebew database, which in turn will refer to a version of `libpng` that
10+
might still be in the correct place.
5211

5312
## Usage
5413

@@ -61,7 +20,6 @@ boxen::example { 'best example ever':
6120
## Required Puppet Modules
6221

6322
* `boxen`
64-
* `anything-else`
6523

6624
## Development
6725

0 commit comments

Comments
 (0)