Skip to content
Snippets Groups Projects
README.md 1.66 KiB
Newer Older
  • Learn to ignore specific revisions
  • Tamer Tas's avatar
    Tamer Tas committed
    # boilr
    
    Tamer Tas's avatar
    Tamer Tas committed
    Are you doing the same steps over and over again every time you start a new programming project?
    
    
    Tamer Tas's avatar
    Tamer Tas committed
    `boilr` is a powerful language-agnostic command-line project templating scaffolding tool here to help you.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    Tamer Tas's avatar
    Tamer Tas committed
    For lots of more details, see [the Wiki page](https://github.com/tmrts/boilr/wiki/Introduction).
    
    Tamer Tas's avatar
    Tamer Tas committed
    # Features
    - Blazingly Fast
    - No dependencies (NodeJS, Python Interpreter etc.)
    - Full power of [golang templates](https://golang.org/pkg/text/template/) (Easy to learn & powerful)
    
    
    # How do I get it?
    There are binaries available for Linux & OSX. You can download them directly,
    
    Tamer Tas's avatar
    Tamer Tas committed
    or run the installation script. Please see [the Wiki page](https://github.com/tmrts/boilr/wiki/Installation) for more information.
    
    Tamer Tas's avatar
    Tamer Tas committed
    # Usage
    
    To use templates shared by others and create your own please take a look at the
    
    Tamer Tas's avatar
    Tamer Tas committed
    [Usage](https://github.com/tmrts/boilr/wiki/Usage) and [Creating Templates](https://github.com/tmrts/boilr/wiki/Creating-Templates)
    
    pages in the wiki.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    # Template Catalog
    
    Tamer Tas's avatar
    Tamer Tas committed
    Take a look at [the Wiki page](https://github.com/tmrts/boilr/wiki/Templates) for a list of project templates, examples, and more information.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    # Contributing
    If you'd like to contribute, share your opinions or learn more, please feel free to open an issue.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    At this stage, user feedback is of **utmost importance**, every contribution is welcome however small it may be.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    ## Reporting Issues
    
    Tamer Tas's avatar
    Tamer Tas committed
    You can report issues **directly from the command-line** by using the command, `boilr report`.
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    A markdown file will be opened where the first line is the issue title and the rest 
    is the issue body. 
    
    Tamer Tas's avatar
    Tamer Tas committed
    
    
    After creating the issue, save & exit the editor and you will be
    prompted for github credentials needed to create the issue.