From 4b3a4c0f2629312d8f3ccd70bd08148eda0cc539 Mon Sep 17 00:00:00 2001
From: Aleksander Shashkin <sasha.shashkin51@gmail.com>
Date: Thu, 13 Oct 2022 22:45:09 +0300
Subject: [PATCH] add README

---
 README | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..7e4105d
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+Misconfict Getter - is a program to get msiconflict for tested task and print it
+in pretty format
+
+--------------------------------------------------------------------------------
+PreInstallation (Use Alt Linux distro based on P10 or Sisyphus)
+
+Install necessary package:
+
+    # apt-get install golang git -y
+
+Clone source code and go to its directory:
+
+    $ git clone ssh://gitea@gitea.basealt.ru/dutyrok/misconflicts_getter.git &&
+      cd misconflicts_getter
+
+Create ~/.local/bin direcotry and add it to PATH enviroment variable:
+
+    $ mkdir -p ~/.local/bin && \
+      echo 'PATH=$PATH:~/.local/bin' >> ~/.bash_profile
+
+Set GOBIN go enviroment variable:
+
+    $ go env -w GOBIN=~/.local/bin
+
+--------------------------------------------------------------------------------
+Build and Install
+
+For build and install execute one command in misconflicts_getter direcotry:
+
+    $ go install .
+
+--------------------------------------------------------------------------------
+Usage
+
+For use program do next:
+
+    $ misconflicts_getter <task_number>
+
+For example:
+
+    $ misconflicts_getter 305052
+
+Output will next:
+
+    postgresql10-perl - postgresql9.5-perl
+                        postgresql9.6-perl
+                        postgresql9.4-perl
+    postgresql11-tcl - postgresql9.4-tcl
+                       postgresql9.6-tcl
+                       postgresql9.5-tcl
+    ...