From 3b13091cd56ae51b725e051aff3ec80cda4866bd Mon Sep 17 00:00:00 2001 From: Bart Van Assche Date: Sat, 13 Jun 2020 16:12:02 +0000 Subject: [PATCH] Convert the README file to the markdown syntax such that it looks better on the github website git-svn-id: http://svn.code.sf.net/p/scst/svn/trunk@9012 d57e44dd-8a1f-0410-8b47-8ef2f437770f --- README | 42 ------------------------------------------ README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 42 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 46f2737fe..000000000 --- a/README +++ /dev/null @@ -1,42 +0,0 @@ -Overview -======== - -This is the SCST development repository. It contains not a single -project SCST as one can think, but a number of them, which are divided -as the following: - -1. SCST core in scst/ subdirectory - -2. Administration utility for SCST core scstadmin in scstadmin/ - -3. Target drivers in own subdirectories qla2x00t/, iscsi-scst/, etc. - -4. User space programs in usr/ subdirectory, like fileio_tgt. - -5. Some various docs in doc/ subdirectory. - -Those subprojects are in most cases independent from each other, -although some of them depend from the SCST core. They put in the single -repository only to simplify their development, they are released -independently. - -Thus, use "make all" only if you really need to build everything. -Otherwise build only what you need, like for iSCSI-SCST: - -make scst scst_install iscsi iscsi_install - -For more information about each subproject see their README files. - - -QLogic target driver -==================== - -The QLogic target driver qla2x00t is the old driver, forked from qla2xxx -several years ago. It is very stable, well tested and actively used in -many production setups. - -There is also a new driver that supports 32 Gb/s FC in the qla2x00t-32gbit -directory. That driver has not yet reached the same maturity level as the -old qla2x00t driver. - -Vladislav Bolkhovitin , http://scst.sourceforge.net diff --git a/README.md b/README.md new file mode 100644 index 000000000..d7719f4bf --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Overview + +This is the source code repository of the SCST project. SCST is a collection +of Linux kernel drivers that implement SCSI target functionality. The SCST +project includes: + +1. The SCST core in the scst/ subdirectory. +2. A tool for loading, saving and modifying the SCST configuration in + directory scstadmin/. +3. Several SCSI target drivers in the directories iscsi-scst/, qla2x00t/, + srpt/, scst_local/ and fcst/. +4. User space programs in the usr/ subdirectory, e.g. fileio_tgt. +5. Various documentation in the doc/ subdirectory. + +## QLogic target driver + +Two QLogic target drivers are included in the SCST project. The driver in +the qla2x00t directory is a very stable driver that supports up to 16 Gb/s +adapters. It is very stable, well tested and actively used in many production +setups. + +There is also a newer driver that supports 32 Gb/s FC in the qla2x00t-32gbit +directory. That driver has not yet reached the same maturity level as the +old qla2x00t driver. + +Vladislav Bolkhovitin , http://scst.sourceforge.net