diff --git a/README.md b/README.md index 9d088bb..a3e73c8 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,96 @@ ![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 `:FT` or simply press the shortcut F2. +In **NORMAL** mode you can use `:FT` ( :FT) or simply press the shortcut F2 (or ). -Under **Linux** you eventually need to disable the **help** shortcut of your **terminal** : +``` +vim 42.c + + :wq + +vim Makefile + :FT + :wq +``` + +### **Quick Setup** + +Below replace "marvin" with your 42 Network login. + +``` +export USER="marvin" +export MAIL="marvin@student.42lausanne.ch" + +./set_header.sh +``` + +In all your git repositories: +``` +git clone git@... project +cd project +git config user.name "marvin" +git config user.email "marvin@student.42lausanne.ch" +``` + +### **Manual Setup** + +Below replace "marvin" with your 42 Network login. + +Copy `stdheader.vim` in your `~/.vim/plugin`. +``` +test -d ~/.vim/plugin || mkdir -p ~/.vim/plugin +cp -va vim/stdheader.vim ~/.vim/plugin +``` + +In all your git repositories: +``` +git clone git@... project +cd project +git config user.name "marvin" +git config user.email "marvin@student.42lausanne.ch" +``` + +UNIX/BSD Distro (MacOS X, FreeBSD, OpenBSD, etc.) +Add in `~/.zshrc` your: +``` +vim ~/.zshrc +export USER="marvin" +export MAIL="marvin@student.42lausanne.ch" + :wq +source ~/.zshrc +``` + +Linux/GNU Distro (Debian/Ubuntu, RedHat/SuSE, Arch, Gentoo, etc.) +Add in `~/.bashrc` your: +``` +vim ~/.bashrc +export USER="marvin" +export MAIL="marvin@student.42lausanne.ch" + :wq +. ~/.bashrc +``` ### **Note** -Inside the **42 clusters** you can easily run: +Your git username and email will always have the priority to $USER and $MAIL variable +if you are outside a git tree and $USER and $MAIL are not defined it will use the +default marvin@student.42lausanne.ch as email and marvin as login for your header. -`$ ./set_header.sh` +The location of this alternative version of stdheader.vim: +- ~/.vim/plugin/stdheader.vim +- $HOME/.vim/plugin/stdheader.vim -The location of stdheader.vim in 42lausanne's clusters: -- /usr/share/vim/vim82/plugin/stdheader.vim -- /usr/share/vim/vim81/plugin/stdheader.vim +The location of the official stdheader.vim in 42lausanne's clusters: - /usr/share/vim/vim80/plugin/stdheader.vim +- /usr/share/vim/vim81/plugin/stdheader.vim (at the time of writing) +- /usr/share/vim/vim82/plugin/stdheader.vim ### **Credits** -[@42Paris](https://github.com/42Paris) -[@zazard](https://github.com/zazard) +- [@42Paris](https://github.com/42Paris) +- [@zazard](https://github.com/zazard) ### **License** diff --git a/img/42header.png b/img/42header.png index 6279725..2a22c15 100644 Binary files a/img/42header.png and b/img/42header.png differ diff --git a/set_header.sh b/set_header.sh index f9263ac..2df8cb7 100755 --- a/set_header.sh +++ b/set_header.sh @@ -5,12 +5,7 @@ if [ ! -z "$USER" ] then - echo 'export USER=`/usr/bin/whoami`' >> ~/.zshrc -fi - -if [ ! -z "$GROUP" ] -then - echo 'export GROUP=`/usr/bin/id -gn ${USER}`' >> ~/.zshrc + echo 'export USER=`whoami`' >> ~/.zshrc fi if [ ! -z "$MAIL" ]