summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndy Grover <agrover@redhat.com>2013-04-30 10:28:22 -0700
committerAndy Grover <agrover@redhat.com>2013-04-30 10:28:22 -0700
commit7503eb761600b3c1bae5307f9a86e088e03fe332 (patch)
treeeb64f4a408fc728be3226eebf8258c87ae9661c6 /README.md
parent85b28fcf3188ef22795b48742bff135b267f435a (diff)
downloadconfigshell-fb-7503eb761600b3c1bae5307f9a86e088e03fe332.tar.gz
Move README to README.md and update for new dev info
Signed-off-by: Andy Grover <agrover@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2c0a917
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+configshell-fb
+==============
+
+A Python library for building configuration shells
+--------------------------------------------------
+configshell-fb is a Python library that provides a framework
+for building simple but nice CLI-based applications.
+
+configshell-fb development
+--------------------------
+configshell-fb is licensed under the Affero GPLv3. Contributions are welcome.
+
+Since configshell-fb is used most often with targetcli-fb, the
+targetcli-fb mailing should be used for configshell-fb discussion.
+
+ * Mailing list: [targetcli-fb-devel](https://lists.fedorahosted.org/mailman/listinfo/targetcli-fb-devel)
+ * Source repo: [GitHub](https://github.com/agrover/configshell-fb)
+ * Bugs: [GitHub](https://github.com/agrover/configshell-fb/issues) or [Trac](https://fedorahosted.org/targetcli-fb/)
+ * Tarballs: [fedorahosted](https://fedorahosted.org/releases/t/a/targetcli-fb/)
+
+"fb" -- "free branch"
+---------------------
+
+configshell-fb is a fork of the "configshell" code written by
+RisingTide Systems. The "-fb" differentiates between the original and
+this version. Please ensure to use either all "fb" versions of the
+targetcli components -- targetcli, rtslib, and configshell, or stick
+with all non-fb versions, since they are no longer strictly
+compatible.