From c9caa1ee68c1633f3641599fa4171f5fd6fa6270 Mon Sep 17 00:00:00 2001
From: Giovanni Harting <539@idlegandalf.com>
Date: Thu, 13 Aug 2020 10:38:13 +0200
Subject: [PATCH] more readme work

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

diff --git a/README.md b/README.md
index 100ea0f..2ecbd95 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,53 @@
 # alhp
 
 Build script for archlinux instructionset enabled repos.
+All packages are build with -march=<cpu-set> and -O3. Some packages will not build with -O3, they will just be installed from the official repos as usual.
+
+## Enable Repos
+To enable these complement repos you need to add them above the matching regular repo in `/etc/pacman.conf`
+
+### Example pacman.conf
+
+```editorconfig
+[core-znver2]
+Server = https://alhp.harting.dev/$repo/os/$arch/
+
+[core]
+Include = /etc/pacman.d/mirrorlist
+
+[extra-znver2]
+Server = https://alhp.harting.dev/$repo/os/$arch/
+
+[extra]
+Include = /etc/pacman.d/mirrorlist
+
+[community-znver2]
+Server = https://alhp.harting.dev/$repo/os/$arch/
+
+[community]
+Include = /etc/pacman.d/mirrorlist
+```
+
+Replace znver2 with your cpu-set. More information about all available options on [this gcc page](https://gcc.gnu.org/onlinedocs/gcc/x86-Options.html).
+Currently alhp.harting.dev only builds for `znver2`, `ivybridge`, `sandybridge` and `skylake` (list is subject to change).
+You can see all available repositories [here](https://alhp.harting.dev/). 
+
+After finished adding the repos to `pacman.conf` you need to import and sign the used pgp key:
+
+Import:
+```
+pacman-key --keyserver keyserver.ubuntu.com --recv-keys 0D4D2FDAF45468F3DDF59BEDE3D0D2CD3952E298
+```
+
+Local sign:
+```
+pacman-key --lsign-key 0D4D2FDAF45468F3DDF59BEDE3D0D2CD3952E298
+```
+
+Update package database:
+```
+pacman -Sy
+```
 
 ## Replace packages
 Following command reinstalls all packages found in the repo **extra-znver2** that are already installed.