Browse Source

Update README file

Serj Kalichev 11 months ago
parent
commit
2cab47fe4b
1 changed files with 33 additions and 3 deletions
  1. 33 3
      README

+ 33 - 3
README

@@ -1,5 +1,35 @@
-Homepage : http://klish.libcode.org.
+# Klish Project
 
-Additional documentation : http://klish.googlecode.com
+The klish is a framework for implementing a CISCO-like CLI on a UNIX systems.
+It is configurable by XML files.
 
-Repository : https://src.libcode.org/pkun/klish
+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.