https://github.com/mrtazz/leoric

Project initialization from skeleton files
https://github.com/mrtazz/leoric

Last synced: about 2 months ago
JSON representation

Project initialization from skeleton files

• Host: GitHub
• URL: https://github.com/mrtazz/leoric
• Owner: mrtazz
• License: mit
• Created: 2015-08-24T01:40:23.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-05-12T16:01:36.000Z (about 10 years ago)
• Last Synced: 2025-06-17T06:45:21.184Z (about 1 year ago)
• Language: Shell
• Homepage: http://code.mrtazz.com/leoric/
• Size: 35.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Leoric

[![Build Status](https://travis-ci.org/mrtazz/leoric.svg?branch=master)](https://travis-ci.org/mrtazz/leoric)

[![Packagecloud](https://img.shields.io/badge/packagecloud-available-brightgreen.svg)](https://packagecloud.io/mrtazz/leoric)

[![Code Climate](https://codeclimate.com/github/mrtazz/leoric/badges/gpa.svg)](https://codeclimate.com/github/mrtazz/leoric)

![](http://i.imgur.com/yXshPER.png)

## Overview

Project initialization from skeleton files. This should just work on any Unix

as the only requirements are bash and m4.

## Usage

```bash

% leoric -s ~/.leoric/skeletons -I ~/.leoric/macros -t ruby -n name

```

Take a look at the [man page][manpage] for more detailed usage instructions.

## Installation

### Linux

In order to ease installation, there are packages on

[packagecloud][packagecloud]. Follow their [install

guide][packagecloud_install] in order to set up the repository for your Linux

distro.

### OSX

```bash

brew tap mrtazz/oss

brew install leoric

```

You can also run the `make install` task if you prefer:

```bash

make install PREFIX=/usr/local

```

It might be a good idea to just set up an alias with default configurations:

```bash

alias leoric='leoric -s ~/.leoric/skeletons -I ~/.leoric/macros'

```

And then use it like `leoric -n name -t ruby`.

## Inspiration and related work

- [git init template directory](http://git-scm.com/docs/git-init)

- [vim skeleton files](http://vimdoc.sourceforge.net/htmldoc/autocmd.html#skeleton)

- [vim-stencil](https://github.com/mrtazz/vim-stencil)

## Why m4?

- it's available almost anywhere

- no real additional dependency

- macros should be simple anyways

[packagecloud]: https://packagecloud.io/mrtazz/leoric

[packagecloud_install]: https://packagecloud.io/mrtazz/leoric/install

[manpage]: http://code.mrtazz.com/leoric/leoric.1.html