From df86a042e687869f6fc875460898f0e41096330e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ing=2E=20Michal=20=C5=A0vamberg?= <svamberg@civ.zcu.cz>
Date: Fri, 19 May 2023 14:33:44 +0000
Subject: [PATCH] Doplneni README.md

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

diff --git a/README.md b/README.md
index 6c4bb6b..064dd3c 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,41 @@ SPDX-FileCopyrightText: 2021-2023 Yoran Heling <projects@yorhel.nl>
 SPDX-License-Identifier: MIT
 -->
 
+# nccf
+
+## instalace zig prostředí
+
+Nedělat na virtálním stroji, pouští se LLVM kompilátor a ten vyžaduje nějaký nevirtualizační procesor.
+
+```
+export PATH=$PATH:/snap/bin
+snap install zig --classic --beta
+apt install -y make libncurses-dev
+```
+
+## build
+```
+git clone https://gitlab.cesnet.cz/702/provoz/nccf.git
+cd nccf
+make
+cp zig-out/bin/ncdu /tmp/nccf
+```
+
+## Jak použít s exclude
+Chci pouze počítat soubory konkrétního uživatele, tzn. vše ostatní se musí excludovat:
+```
+find . \! -user nagios | cut -c 3- > /tmp/exclude.txt
+nccf . -x -X /tmp/exclude.txt
+```
+
+## Uložit a načíst s kompresí
+
+```
+nccf . -x -o - | gzip > /tmp/out.nccf.gz
+zcat /tmp/out.nccf.gz | nccf -r -f -
+```
+
+
 # ncdu-zig
 
 ## Description
-- 
GitLab