summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 24 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..03e113d
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+# This file is part of ConfigShell Community Edition.
+# Copyright (c) 2011 by RisingTide Systems LLC
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, version 3 (AGPLv3).
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ConfigShell Community Edition is a python library that provides a framework
+for building simple but nice CLI-based applications.
+
+For more information, see the configshell API reference, available in both html
+and pdf formats as a separate package.
+
+To run the example shell from this directory use:
+PYTHONPATH=. ./examples/myshell
+