Initial Commit of stdheader for 42lausanne

README.md

@@ -0,0 +1,45 @@
+# **42 Header**
+
+42Lausanne (Switzerland)
+
+### **Description**
+
+42 standard header for vim editor.
+
+![42 header](img/42header.png)
+
+### **UNIX Setup**
+
+Add in `~/.zshrc` your:
+
++ `USER`
++ `MAIL`
+
+Copy `stdheader.vim` in your `~/.vim/plugin`.
+
+### **Usage**
+
+In **NORMAL** mode you can use `:Stdheader` or simply press the shortcut <kbd>F1</kbd>.
+
+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 <kbd>F1</kbd>
+
+### **Note**
+
+Inside the **42 clusters** you can easily run:
+
+`$ ./set_header.sh`
+
+The location of stdheader.vim in 42lausanne's clusters:
+- /usr/share/vim/vim81/plugin/stdheader.vim
+- /usr/share/vim/vim80/plugin/stdheader.vim
+
+### **Credits**
+
+[@42Paris](https://github.com/42Paris)
+[@zazard](https://github.com/zazard)
+
+### **License**
+
+This work is published under the terms of **[42 Unlicense](https://github.com/gcamerli/42unlicense)**.