Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eputnam/read2ref
Generate Puppet Strings-style code comments for your Puppet code.
https://github.com/eputnam/read2ref
Last synced: 18 days ago
JSON representation
Generate Puppet Strings-style code comments for your Puppet code.
- Host: GitHub
- URL: https://github.com/eputnam/read2ref
- Owner: eputnam
- License: mit
- Created: 2018-04-01T17:56:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-02T16:23:26.000Z (over 6 years ago)
- Last Synced: 2024-09-27T00:15:31.959Z (about 2 months ago)
- Language: Ruby
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Read2ref
A gem for generating Puppet Strings-like comments in Supported Modules
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'read2ref'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install read2ref
## Usage
Currently, this can be run as a script with two arguments:
1. Path to the module's README
2. Glob for the modules manifests (don't forget to escape asterisks)
```shell
ruby lib/read2ref.rb path/to/readme glob/for/manifests/\*/\*\*
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/eputnam/read2ref.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).