https://github.com/bodacious/underkill
https://github.com/bodacious/underkill
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bodacious/underkill
- Owner: Bodacious
- License: mit
- Created: 2020-04-09T08:17:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T08:30:59.000Z (about 6 years ago)
- Last Synced: 2025-02-28T01:22:33.808Z (over 1 year ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Underkill
The World's lightest static website generator.
NOTE: Work in progess, please check back later...
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'underkill'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install underkill
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/underkill.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).