aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2018-04-18 08:16:53 +0200
committerAndreas Schneider <asn@cryptomilk.org>2018-04-18 10:51:43 +0200
commitabd1a1f372c0fe3ce1a05a0800258c3bb01a12be (patch)
tree67e4cc88c4e3bc9a506305c7e89855521e23329c
parentc705fb6e3bef59d6c4c36991030cb07ec22d07dc (diff)
downloadlibssh-abd1a1f372c0fe3ce1a05a0800258c3bb01a12be.tar.gz
libssh-abd1a1f372c0fe3ce1a05a0800258c3bb01a12be.tar.xz
libssh-abd1a1f372c0fe3ce1a05a0800258c3bb01a12be.zip
README: Added markdown readmine with gitlab CI badge
Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com> Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..450b67ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+[![pipeline status](https://gitlab.com/libssh/libssh-mirror/badges/master/pipeline.svg)](https://gitlab.com/libssh/libssh-mirror/commits/master)
+
+```
+ _ _ _ _
+ (_) (_) (_) (_)
+ (_) _ (_) _ _ _ _ _ (_) _
+ (_) (_) (_)(_) _ (_)(_) (_)(_) (_)(_) _
+ (_) (_) (_) (_) _ (_) _ (_) (_) (_)
+ (_) (_) (_)(_)(_) (_)(_) (_)(_) (_) (_).org
+
+ The SSH library
+
+```
+
+# Why?
+
+Why not ? :) I've began to work on my own implementation of the ssh protocol
+because i didn't like the currently public ones.
+Not any allowed you to import and use the functions as a powerful library,
+and so i worked on a library-based SSH implementation which was non-existing
+in the free and open source software world.
+
+
+# How/Who?
+
+If you downloaded this file, you must know what it is : a library for
+accessing ssh client services through C libraries calls in a simple manner.
+Everybody can use this software under the terms of the LGPL - see the COPYING
+file
+
+If you ask yourself how to compile libssh, please read INSTALL before anything.
+
+# Where ?
+
+https://www.libssh.org
+
+# Contributing
+
+Please read the file 'SubmittingPatches' next to this README file. It explains
+our copyright policy and how you should send patches for upstream inclusion.
+
+Have fun and happy libssh hacking!
+
+The libssh Team