hen

0.9.1last stable release 6 years ago
Complexity Score
Low
Open Issues
N/A
Dependent Projects
31
Weekly Downloadsglobal
513

License

  • AGPL-3.0
    • Yesattribution
    • Copyleftlinking
    • Copyleftdistribution
    • Copyleftmodification
    • Yesprivate use

Downloads

Readme

= hen - Just a Rake helper

== VERSION

This documentation refers to hen version 0.9.1

== DESCRIPTION

Hen is a Rake helper framework, similar to Hoe[http://docs.seattlerb.org/hoe/] or Echoe[https://github.com/evan/echoe]. It provides you with a set of common Rake tasks by placing a little snippet like the following in your Rakefile:

require ‘hen’ require ‘your/lib/version’

Hen.lay! {{ gem: { name: ‘gem_name’, version: Your::Lib::VERSION, summary: ‘Project summary’, author: ‘Your Name’, email: ‘you@e.mail‘ } }}

=== Generate a global configuration file

Hen will read configuration options from your global configuration file if it’s present. You can generate a minimal .henrc with the +hen+ script:

hen config

This will create a new .henrc file in your home directory.

=== Create a new project

For new projects, you can also use the +hen+ script to create an initial project directory for you that comes with default files and configuration:

hen create path/to/your/lib

You can even provide a project template of your own:

hen create path/to/your/lib path/to/your/template

In addition to that, +hen+ can setup your new project with Git support:

hen create path/to/your/lib -g

See hen help for further information.

=== Extending Hen

You can even extend Hen with your own tasks. More on that later. (TODO)

== LINKS

Documentation:: https://blackwinter.github.com/hen Source code:: https://github.com/blackwinter/hen RubyGem:: https://rubygems.org/gems/hen

== AUTHORS

  • Jens Wille mailto:jens.wille@gmail.com

== LICENSE AND COPYRIGHT

Copyright (C) 2007-2012 University of Cologne, Albertus-Magnus-Platz, 50923 Cologne, Germany

Copyright (C) 2013-2019 Jens Wille

hen is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

hen is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with hen. If not, see http://www.gnu.org/licenses/.

== CODE OF CONDUCT

Please note that this project is released with a {Contributor Code of Conduct}[link:CONDUCT.html]. By participating in this project you agree to abide by its terms.

Dependencies

CVE IssuesActive
0
Scorecards Score
3.00
Test Coverage
No Data
Follows Semver
No
Github Stars
4
Dependenciestotal
3
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No Data
Repo Audits
No Data

Learn how to distribute hen in your own private RubyGems registry

gem install hen
Processing...
Done

66 Releases

RubyGems on Cloudsmith

Getting started with RubyGems on Cloudsmith is fast and easy.