|
1 | | -# Using this Template |
| 1 | +ScreenFlow Puppet Module for Boxen |
2 | 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 checkout -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 | | - |
36 | | -# Template Puppet Module for Boxen |
37 | | - |
38 | | -An example of how we write Puppet modules for Boxen. Replace this |
39 | | -paragraph with a short explanation of what the heck makes your module |
40 | | -useful. |
41 | | - |
42 | | -A great module has a working travis build |
43 | | - |
44 | | -[](https://travis-ci.org/boxen/puppet-template) |
| 3 | +Install [ScreenFlow](http://www.telestream.net/screenflow/), screencasting and screen recording software. |
45 | 4 |
|
46 | 5 | ## Usage |
47 | 6 |
|
48 | 7 | ```puppet |
49 | | -boxen::example { 'best example ever': |
50 | | - salutation => 'fam' |
51 | | -} |
| 8 | +include screenflow |
52 | 9 | ``` |
53 | 10 |
|
54 | 11 | ## Required Puppet Modules |
55 | 12 |
|
56 | 13 | * `boxen` |
57 | | -* `anything-else` |
58 | 14 |
|
59 | 15 | ## Development |
60 | 16 |
|
61 | | -Set `GITHUB_API_TOKEN` in your shell with a [Github oAuth Token](https://help.github.com/articles/creating-an-oauth-token-for-command-line-use) to raise your API rate limit. You can get some work done without it, but you're less likely to encounter errors like `Unable to find module 'boxen/puppet-boxen' on https://github.com`. |
| 17 | +Write code. Run `script/cibuild` to test it. Check the `script` |
| 18 | +directory for other useful tools.irectory for other useful tools. |
62 | 19 |
|
63 | | -Then write some code. Run `script/cibuild` to test it. Check the `script` |
64 | | -directory for other useful tools. |
0 commit comments