Browse Source

README -> README.md

Serj Kalichev 1 year ago
parent
commit
186d77b2fe
2 changed files with 35 additions and 3 deletions
  1. 0 3
      README
  2. 35 0
      README.md

+ 0 - 3
README

@@ -1,3 +0,0 @@
-Homepage : http://faux.libcode.org.
-Repository : https://src.libcode.org/pkun/faux
-See for documentation in sourcecode tree docs/ dir.

+ 35 - 0
README.md

@@ -0,0 +1,35 @@
+# The faux library.
+
+## About
+
+The library contains a set of auxiliary functions. These functions are:
+
+* Base I/O and memory functions
+* String functions
+* Text to integer conversion functions
+* System DBs related functions
+* List implementation
+* Working with INI files
+* Working with file line-by-line
+* Etc.
+
+Also project contains `testc` binary. It's a utility that helps to write and
+execute unit tests in C. See the following documentation:
+
+https://src.libcode.org/pkun/faux/src/master/docs/testc.ru.md `testc` documentation in Russian
+https://src.libcode.org/pkun/faux/src/master/docs/testc.en.md `testc` documentation in English
+
+The main target platform for library is a Linux. The project is written in C.
+
+
+## Resources
+
+Homepage : http://faux.libcode.org
+
+Repository : https://src.libcode.org/pkun/faux
+
+Mailing list : http://groups.google.com/group/libfaux.
+
+Download : https://src.libcode.org/pkun/faux/archive/1.2.2.tar.gz
+
+Author: Serj Kalichev `<serj.kalichev(_at_)libcode.org>`