Add readme files.

2 files changed, 58 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e680da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Ast Dumper - static code analyser for C/C++
+
+This is gcc plugin for dump AST tree and search possible null pointers.
+
+Version 1.0       Date: 2015-06-22
+
+## Build deps
+ - gcc 5 with plugin includes. (gcc-5-plugin)
+   For older gcc build possible, but need change make file.
+ - automake/autoconf.
+
+## Run time deps
+ - gcc 5 / g++ 5 or older.
+
+## Features
+ - Dump AST tree from gcc.
+ - Search missing basic null pointer checks for function input parameters.
+ - Dont check parameters with attribute [NONNULL](https://gcc.gnu.org/onlinedocs/gcc-5.1.0/gcc/Function-Attributes.html#index-g_t_0040code_007bnonnull_007d-function-attribute-3189).
+ - In future probably other checks...
+
+## Build
+ - Run build.sh
+ - You will get astdumper.so for gcc binary
+   and cppastdumper.so for g++ binary
+
+## Usage examples
+In directory [examples] present two examples one for C++ and other for C.
+
+
+Readme on russian [README.ru.md]
diff --git a/README.ru.md b/README.ru.md
new file mode 100644
index 0000000..f977716
--- /dev/null
+++ b/README.ru.md
@@ -0,0 +1,28 @@
+# Ast Dumper - статический анализатор C/C++ кода.
+
+Представляет собой плагин к компилятору gcc.
+Есть возможность вывода абстрактного синтаксического дерева (AST) и поиска нулевых указателей.
+
+Версия 1.0       Дата: 2015-06-22
+
+## Зависимости для компиляции
+ - gcc 5 с заголовочными файлами для плагинов. (gcc-5-plugin)
+   Также возможно компиляции для более старых версий gcc, но нужно модифицировать сборочный файл.
+ - automake/autoconf.
+
+## Зависимости исполнения
+ - gcc 5 / g++ 5 или старее.
+
+## Функции
+ - Вывод AST дерева из недр gcc.
+ - Поиск пропущенных проверок входных параметров-указателей в функциях на ноль.
+ - Пропуск проверки на нулевой указатель если паарметр имеет атрибут [NONNULL](https://gcc.gnu.org/onlinedocs/gcc-5.1.0/gcc/Function-Attributes.html#index-g_t_0040code_007bnonnull_007d-function-attribute-3189).
+ - В будущем возможно другие проверки...
+
+## Компиляции
+ - Запустить build.sh
+ - Вы получите два файла. astdumper.so для C/gcc.
+   и cppastdumper.so для C++/g++
+
+## Примеры использования
+В директории [examples] находится два примера для C++ и C.