jetbrains-ide-file-templates

This repository contains file templates for JetBrains IDEs for better formatting of documentation. This also helps for faster programming.

Requirements

• The unix make tool
• The unix zip tool

Installation

Checkout the repository to any directory on your computer and run the make file. This will create a compressed settings.jar file in the directory where the repository was cloned to.

# Clones the repository
git clone https://github.com/basvandriel/jetbrains-ide-file-templates.git

# Builds the MAKEFILE
make

Afterwards open one of the supported JetBrains IDEs and go to File > Import Settings... and select and import the previous generated settings.jar file.

To use the file templates open your project and go to File > Settings > Editor > File and Code templates and navigate to the Includes tab.

In here open the author-variables.vtl file and change the $AUTHOR_NAME and $AUTHOR_EMAIL to the corresponding name and email address.

## Author variables
##
## Author's full name
#set($AUTHOR_NAME = "Bas van Driel")
##
## Author's email address
#set($AUTHOR_EMAIL = "basvandriel94@gmail.com")

---

Project license

You can also add a project license the class documentation.

By default, the project license is set to the MIT license. You can change this by opening up the license-variable file and changing the $PROJECT_LICENSE variable to the desired project license.

Note that these have to be changed every time you work in another project if you want another license.

The supported licenses are currently:

• MIT
• The Unlicensed

Having a project license is not required.

License

This project is licensed under the The Unlicensed - see the LICENSE.md file for details.

Links

• Source code
• Issue tracker