From 8a73acbaca2cd5304d97a6f28e730281ed1bc750 Mon Sep 17 00:00:00 2001
From: Antoine Huguet <antoine.huguet@student-cs.fr>
Date: Wed, 10 Feb 2021 12:59:11 +0100
Subject: [PATCH] Updated readme

---
 README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)

diff --git a/README.md b/README.md
index eddadc6..b57506c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,80 @@
 # Shell Pics
 
+This is a ZSH shell config aimed to be used on Pics server.
+
+![General preview](https://storage.galerie.pics/geek/oh-my-pics.png "ZSH config preview")
+
+## Install ZSH
+
+```shell
+sudo apt install zsh
+```
+
+## One step installation
+
+#### Clone repository
+
+```shell
+git clone https://gitlab.viarezo.fr/2019hugueta2/shell-pics ~/shell-pics
+```
+
+#### Start installation
+
+Do **not** install as **sudo**.
+
+```shell
+~/shell-pics/install.sh
+```
+
+#### Follow instructions
+
+
+#### Remove installation folder
+
+```shell
+rm -r ~/shell-pics
+```
+
+
+## Set up your terminal
+
+
+You'll need to install a ***Powerline*** compatible font (**on your personal computer**).
+
+### On Linux & MacOs
+
+```shell
+git clone https://github.com/powerline/fonts.git
+./font/install.sh
+```
+
+### On Windows
+
+On any shell run :
+```shell
+cd $HOME
+git clone https://github.com/powerline/fonts.git
+```
+
+Then by using **Powershell ad Administrator** run :
+```shell
+cd $HOME\fonts
+Set-ExecutionPolicy Bypass
+```
+
+Confirm (y) and then :
+```shell
+.\install.ps1
+```
+
+When the installation is complete :
+```shell
+Set-ExecutionPolicy Default
+```
+
+### Select your font
+
+And then you have to select a ***Powerline*** compatible font ( ***'for Powerline'*** ). Open **Preferences > Profiles > Text > Change Font** in your terminal.
+
+![Change Font](https://storage.galerie.pics/geek/powerline-font.png "Change Font")
+
-- 
GitLab