home.md

 # CodeChecker
 
-CodeChecker is a tool for C code style analysis.
+CodeChecker - инструмент для анализа стиля исходного кода на языке программирования С.
 
-Source http://git.iu7.bmstu.ru/IU7-Projects/CodeChecker
+## Установка
 
-Support http://git.iu7.bmstu.ru/IU7-Projects/CodeChecker/issues
+Необходимо загрузить исходный код программы http://git.iu7.bmstu.ru/IU7-Projects/CodeChecker
+
+Перейти в папку CodeChecker/CodeChecker
+
+Выполнить make
+
+## Использование
+
+Для корректной работы программы необходимо добавить переменную среды с путем к файлу с правилами.
+
+В качестве шаблона можно воспользоваться файлом CodeChecker/CodeChecker/Rules.txt.
+
+В Linux: добавьте переменную **RULES_PATH=Path_to_rules** в .profile.
+
+В Windows: добавьте **RULES_PATH=Path_to_rules** в переменные среды (Система -> Дополнительные параметры системы -> Переменные среды).
+
+Для запуска программы выполните **CodeChecker.exe file.c**
+
+## Поддержка
+Если вы обнаружили баг в программе, сообщите о нем нам.
+
+Для этого создайте issue (http://git.iu7.bmstu.ru/IU7-Projects/CodeChecker/issues).
+
+В issue необходимо указать:
+*  Текущую версию программы (SHA-1 git last commit).
+*  Вашу операционную систему.
+*  Команду, которой вы запускали программу.
+*  Файлы исходного кода, на которых возникла ошибка.
+
+
+Статья:[статья.pdf](/uploads/d0bb5cfb6bce1fca36541964e2706834/статья.pdf)
 
 The program is made by Ermishechkin Aleksandr and Avagyan Ashot.