summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Grover <agrover@redhat.com>2013-04-30 10:24:15 -0700
committerAndy Grover <agrover@redhat.com>2013-04-30 10:24:15 -0700
commit0ac1b9eefdd866251ddf6dc4c71ef8855a5f047d (patch)
treeb611d631eef440af747ed69b8cc5da42b3dda15d
parent88e7bf56a9e1601773500193f2e1faafddf1b151 (diff)
downloadrtslib-fb-0ac1b9eefdd866251ddf6dc4c71ef8855a5f047d.tar.gz
Rename README to READM.md and update for new project info
Signed-off-by: Andy Grover <agrover@redhat.com>
-rw-r--r--README51
-rw-r--r--README.md28
2 files changed, 28 insertions, 51 deletions
diff --git a/README b/README
deleted file mode 100644
index ad547a0..0000000
--- a/README
+++ /dev/null
@@ -1,51 +0,0 @@
-rtslib-fb
-
-rtslib-fb ("free branch") is a tree that tracks RTS's upstream
-git repo, but with additional patches. Like the upstream version,
-these patches are available under AGPLv3, but sole copyright no longer
-belongs to RTS, since additional patch copyrights are still held by
-their respective authors.
-
-Please use Github facilities for code contributions and bug reports:
-
-https://github.com/agrover/rtslib-fb
-
-Release tarballs are available from:
-
-http://pypi.python.org/pypi/rtslib (new)
-
-https://github.com/agrover/rtslib-fb/tags (pre-fb25)
-
------
-
-# This file is part of RTSLib 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/>.
-
-RTSLib Community Edition is a python library that provides an object API to
-RisingTide Systems generic SCSI Target as well as third-party target fabric
-modules written for it and backend storage objects.
-
-The latest version of this program might be obtained at:
-http://www.risingtidesystems.com/git/
-
-The git reposirory can be directly accessed from:
-git://risingtidesystems.com/rtslib.git
-git://linux-iscsi.org/rtslib.git
-
-It is useful for developing 3rd-party applications, as well as serving as a
-foundation for RisingTide Systems userspace tools.
-
-For more information, see the rtslib API reference, available in html
-format as a separate package.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7cc8329
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+rtslib-fb
+=========
+
+A Python object API for managing the Linux LIO kernel target
+------------------------------------------------------------
+rtslib-fb is an object-based Python library for configuring the LIO
+generic SCSI target, present in 3.x Linux kernel versions.
+
+rtslib-fb development
+---------------------
+rtslib-fb is licensed under the Affero GPLv3. Contributions are welcome.
+
+Since rtslib-fb is used most often with targetcli-fb, the targetcli-fb
+mailing should be used for rtslib-fb discussion.
+
+ * Mailing list: [targetcli-fb-devel](https://lists.fedorahosted.org/mailman/listinfo/targetcli-fb-devel)
+ * Source repo: [GitHub](https://github.com/agrover/rtslib-fb)
+ * Bugs: [GitHub](https://github.com/agrover/rtslib-fb/issues) or [Trac](https://fedorahosted.org/targetcli-fb/)
+ * Tarballs: [fedorahosted](https://fedorahosted.org/releases/t/a/targetcli-fb/)
+
+"fb" -- "free branch"
+---------------------
+
+rtslib-fb is a fork of the "rtslib" 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.