README.md

README

@@ -1,35 +0,0 @@
-# Klish Project
-
-The klish is a framework for implementing a CISCO-like CLI on a UNIX systems.
-It is configurable by XML files.
-
-It's a stable klish branch for version 2.
-
-
-## Homepage
-
-http://klish.libcode.org.
-
-
-## Documentation
-
-See the homepage and sourcecode tree "doc/" dir for documenation.
-
-
-## Repository
-
-https://src.libcode.org/pkun/klish
-
-NOTE: You need branch "2.2" for stable version.
-The "master" branch is used for development of klish version 3 and it's not functional for now.
-
-
-## Contributing
-
-Use klish mailing list http://groups.google.com/group/klish-dev to send patches.
-The best practice is to use "git format-patch" to format patch and "git send-email" to send it.
-It's great when the patch (or email) contain description for patch.
-
-## Build
-
-Klish project needs XML parsing library like libxml2. See the documentation for details.

README.md

@@ -0,0 +1,44 @@
+# Klish Project
+
+## About
+
+The klish is a framework for implementing a CISCO-like CLI on a UNIX systems.
+
+For stable klish version 2 see the "2.2" branch.
+
+It is configurable by XML files. The KLISH stands for Kommand Line Interface
+Shell. I know that "command" starts with "c" :) .
+
+The klish is a fork of clish 0.7.3 project (http://sourceforge.net/projects/clish/).
+The original clish was developed by Graeme McKerrell. The klish obtain some new
+features but it's compatible (as much as possible) with clish's XML
+configuration files. The author of klish project is Serj Kalichev.
+
+The main target for the klish is a Linux platform. Additionally it can be build on
+FreeBSD, OpenBSD, Solaris, QNX. The klish project is written in C.
+
+The klish development is sponsored by "Factor-TS" company http://www.factor-ts.ru/.
+
+## Build
+
+NOTE:
+You need branch "2.2" for stable version.
+
+Klish project needs XML parsing library like libxml2. See the documentation for details.
+
+## Resources
+
+Homepage : http://klish.libcode.org
+
+Docs : See the sourcecode tree "doc/" dir for documenation
+
+Repository : https://src.libcode.org/pkun/klish BRANCH 2.2
+
+Mailing list : http://groups.google.com/group/klish
+
+Dev mailing list : http://groups.google.com/group/klish-dev
+
+Download : Not stable yet
+
+Author : Serj Kalichev `serj.kalichev(_at_)libcode.org`
+