subtub / subtool

internal subtub tool

subtool v0.0.7

Table of Content

General Information
Getting Started
The .subfile

General Information

This is an internal subtub tool.
It should generate readme, license and other files for our projects and repositories.

back to table of content

Getting Started

Installation

Install the latest subtool release with the Node Package Manager by running:

sudo npm install -g https://github.com/subtub/subtool/tarball/master

To install a specific version run:

sudo npm install -g https://github.com/subtub/subtool/archive/v0.0.6.tar.gz

To uninstall run:

sudo npm uninstall -g subtool

back to table of content

The .subfile

If you want to generate README.md files with the subtool, you need a .subfile to configure the generator.

A .subfile looks like:

// subtool configuration file
module.exports = { version: '0.0.4',

  // Set GitHub User- and Project-Name.
  github: {
    username: 'NAME',
    project: 'PROJECT'
  },

  // Settings for the README.md file.
  readme: {
    // Generate a Table of Content Markdown list.
    toc: true,
    content: [
      { title: 'General Information',  file: '/docs/general_information.md' }
    ]
  },
  
  // Set the type of License you want to use. Choose between the following types:
  // apache, freebsd, isc, mit, newbsd
  license: 'mit',

  // If true, generate a CONTRIBUTING.md file.
  contributing: true,
  
  // If true, 
  travis: {
    language: 'node_js',
    version: ['0.4', '0.6', '0.8', '0.10']
  }
}

back to table of content

Contributors

 project  : subtool
 repo age : 7 weeks
 active   : 21 days
 commits  : 203
 files    : 191
 authors  : 
   200	Paul Vollmer            98,5%
     3	Tim Pulver              1,5%

This summary is generated by the git-summary script.

back to table of content

License

The MIT License (MIT)  
  
Copyright (c) 2013 subtub  
  
Permission is hereby granted, free of charge, to any person obtaining a copy  
of this software and associated documentation files (the "Software"), to deal  
in the Software without restriction, including without limitation the rights  
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  
copies of the Software, and to permit persons to whom the Software is  
furnished to do so, subject to the following conditions:  
  
The above copyright notice and this permission notice shall be included in  
all copies or substantial portions of the Software.  
  
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  
THE SOFTWARE.  

back to table of content

---

This Readme was generated by subtool on Tue Oct 29 2013 20:20:30 GMT+0100 (CET).

subtool's Issues

template engine

welche template engine wollen wir benutzen?

This Readme was generated by `subtool` link bug

link not correct

Add lint task to Makefile

Include other files in Markdown

By using {{include=/foo/bar.md}} we include an other markdown file into the current working file.

.subfile?

wie soll unsere subtool hauptdatei heißen?

subfilefinde ich gut, weil es an Makefileetc. dran ist. Vieleicht sollte man den Punkt vorne wieder wegnehmen...
also von mir aus 👍 für subfile

subtool update

ein commando um das tool zu aktualisieren

ich denke da an

subtool update

ist ja eigentlich selbsterklärend :)

coffeescript

wechseln zu coffeescript

readme option to auto comment the generated README.md

Add a option to the readmecommand to git add README.md and git commit the file.

I think an option like -g is a good one

subtool readme -g

subconfig

Eine config file für das subtool.

readme table of content anchor bug

rename anchor from

#General Information

to

#general-information

if a slash exists, ignore it.

include function -> module

hello, wollen wir die include funktion welche wir fpr markdown gebaut haben extrahieren und ein eigenes modul draus machen?

dann können wir die funktion nicht nur für markdown benutzen...
ich könnte mir das auch ganz gut beim templates/sourcecode generieren vorstellen.

Das modul könnte dann recursiveInclude heissen. Sollte eine cli haben und ein gutes interface für die programmatische schnittstelle.
mit dem cli können wir dann in jedem projekt files rekursiv ineinander verschackteln...