Browse Source

README -> README.md

Serj Kalichev 2 months ago
parent
commit
ce493213e7
1 changed files with 17 additions and 18 deletions
  1. 17 18
      README.md

+ 17 - 18
README → README.md

@@ -1,39 +1,38 @@
 # Klish Project
 
+## About
+
 The klish is a framework for implementing a CISCO-like CLI on a UNIX systems.
 
 NOTE: It's a development branch for fully rewritten klish version 3.
 It's not functional for now.
 For stable klish version 2 see the "2.2" branch.
 
+The main target for the klish is a Linux platform.
 
-## Homepage
-
-http://klish.libcode.org.
 
+## Build
 
-## Documentation
-
-See the homepage and sourcecode tree "doc/" dir for documenation.
+NOTE:
+You need branch "master" for development non-stable version.
+You need branch "2.2" for stable version.
 
+The development master branch needs libfaux (http://faux.libcode.org) to be built.
+The stable branch 2.2 doesn't need libfaux library.
 
-## Repository
 
-https://src.libcode.org/pkun/klish
+## Resources
 
-NOTE:
-You need branch "master" for development non-stable version.
-You need branch "2.2" for stable version.
+Homepage : http://klish.libcode.org
 
+Docs : See the sourcecode tree "doc/" dir for documenation
 
-## Contributing
+Repository : https://src.libcode.org/pkun/klish
 
-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.
+Mailing list : http://groups.google.com/group/klish
 
+Dev mailing list : http://groups.google.com/group/klish-dev
 
-## Build
+Download : Not stable yet
 
-The development master branch needs libfaux (http://faux.libcode.org) to be built.
-The stable branch 2.2 doesn't need libfaux library.
+Author : Serj Kalichev `serj.kalichev(_at_)libcode.org`