Skip to content

jeremt/sublime-header

Repository files navigation

#Sublime Header

It's a simple plugin which generates an epitech norme compatible header.

##Install

###Manual installation

Download the plugin or clone the repository.

Then copy the containing folder into your SublimeText Packages folder: Preferences -> Browse Packages...

###With Package Control

Add https://github.com/jeremt/sublime-header as a new repository : ctrl+shift+p -> Package Control: Add repository

Install it : ctrl+shift+p -> Package Control: Install package "Sublime Header"

You can configure the package by editing Sublime header settings :

Preferences -> Package Settings -> Sublime Header -> Settings - User

{
    "name" : "Your Name",
    "mail" : "your.mail@mailbox.com",
    "allowed_languages" :
    [
        "Python",
        "C"
    ],
    "disallowed_languages" :
    [
        "JSON",
        "Markdown"
    ],
}

(Sublime Header will check if current file syntax is in the disallowed list first, then check if it is in the allowed list. You can use one or both lists)

##Usage

Just press ctrl+shift+h to generate a header at the top of the file.

TODO

  • Add all languages
  • Configuration file to create custom headers

##License

(The MIT License)

Copyright (c) 2012 Jeremie T. taboada.jeremie@gmail.com

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.

About

It's a simple plugin which is generated an epitech norme compatible header.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published