Browse Source

update README to use markdown, and create a new blank README.markdown

master
Aaron Hicks 7 years ago
parent
commit
aa230b8323
2 changed files with 27 additions and 11 deletions
  1. 17
    0
      README.markdown
  2. 10
    11
      README1st.markdown

+ 17
- 0
README.markdown View File

@@ -0,0 +1,17 @@
# blank

This is a blank puppet module.

*NOTE:* Check README1st.markdown for usage of the blank puppet module template.

# Licensing

Update your license details here.

# Attribution

This module is derived from the puppet-blank module by Aaron Hicks (aethylred@gmail.com)

* https://github.com/Aethylred/puppet-blank

<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons Licence" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>

README → README1st.markdown View File

@@ -9,7 +9,7 @@ Use this module to start a new blank puppet module with all the required compone
## Create a new blank module

1. Clone this repository:
git clone -o puppet-blank -b master git://github.com/Aethylred/puppet-blank.git /path/to/new/repository
git clone -o puppet-blank -b master git://github.com/Aethylred/puppet-blank.git /path/to/new/repository

## Windows scripts

@@ -17,22 +17,23 @@ Provided are some Powershell scripts that can be used to manage the blank puppet

## Enable execution of unsigned scripts

Powershell will not run unsigned scripts by default, this can be corrected by executing the following command in an Administrator Powershell. This is required before any of the other powershell scripts will run.
Powershell will not run unsigned scripts by default, this can be enabled by executing the following command in an Administrator Powershell. This is required before any of the other powershell scripts will run.

1. Click *Start* menu
2. Type "powershell" in the *Search programs and files* box, do not press enter.
3. When *Powershell* shows up in the search results, right click and select *Run as administrator*
4. Windows UAC may ask for permission to run as an administrator, click *Yes*
5. Run the following command in the administrator Powershell:
set-executionpolicy remotesigned
set-executionpolicy remotesigned
6. Press *Enter* again to confirm the policy change

## Change author
## Change author and module

This updates the author and module name using the `.orig` templates. This script can be re-run, creating new templates. This may not be advisable in later stages of module development.

1. Start Powershell in the blank module directory
2. Run the `setauthor.ps1` script:
./setauthor.ps1 newauthor
3. This creates a new `Modulefile` from `Modulefile.orig`, open it in an editor and check it's correct.
2. Run the `unblank.ps1` script:
./setauthor.ps1 newauthor newmodule

# Frequently Asked Questions

@@ -42,7 +43,7 @@ More like questions that should be asked.

This module started with the standard module generation using

puppet module generate blank
puppet module generate blank

...so why not continue to use it?

@@ -50,6 +51,4 @@ This module is intended for:

1. Writing a module where puppet is not or can not be installed

2. Use as a starting point for a collection of modules and prepopulated with things like licensing, boiler plate, pictures of cats, etc. etc.

3.
2. Use as a starting point for a collection of modules and prepopulated with things like licensing, boiler plate, pictures of cats, etc. etc.

Loading…
Cancel
Save