Skip to content

README.md

Latest commit

 

History

History
65 lines (37 loc) · 1.65 KB

README.md

File metadata and controls

65 lines (37 loc) · 1.65 KB

Codam Header

Codam (Amsterdam)

Description

Codam standard header for vim editor.

Codam header

UNIX Setup

Copy stdheader.vim in your ~/.vim/plugin, or use your favorite plugin manager. Then set the user and mail variables as explained below.

Option 1: export USER and MAIL in your shell configuration file

Use echo $0 to determine if you are using bash or zsh shell.

Add in ~/.zshrc or ~/.bashrc (create the files if they do not exist):

export USER='yourLogin'
export MAIL='yourLogin@student.codam.nl'

This sets the USER abd MAIL environment variables across your entire system.

Option 2: set user and mail values directly in your vimrc

let g:user42 = 'yourLogin'
let g:mail42 = 'yourLogin@student.codam.nl'

Usage

In NORMAL mode you can use :Stdheader or simply press the shortcut F1.

Under Linux you eventually need to disable the help shortcut of your terminal :

For Terminator, right click -> Preferences -> Shortcuts -> change help with something other than F1

Note

Inside the Codam clusters you can easily run:

$ ./set_header.sh

Credits

@zazard - creator

@alexandregv - contributor

@mjacq42 - contributor

@sungmcho - contributor

@fclivaz42 - contributor

@FreekBes - adapted for Codam

License

This work is published under the terms of 42 Unlicense.