summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1770619
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+What is kdeplayground?
+----------------------
+
+The kdeplayground modules contain software that is under development but
+that has not reached a stable state. Some software present has only been
+developed as a proof of concept and will not see further development.
+Due to the experimental nature of the software, most of the software in
+the kdeplayground packages has not received the same level of scrutiny
+as the software in other modules.
+
+Although the software in the kdeplayground modules is publicly available
+for the purpose of its ongoing development, it should not be considered
+released, supported in any way or fit for any purpose.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS `AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Package contents
+----------------
+
+Read the INDEX file to find out about the description and status of each
+module.
+
+
+Using kdeplayground
+-------------------
+
+The modules use the standard autoconf/automake based KDE build system. To
+add a new module to the build, create a subdirectory with your code and then
+say "make -f Makefile.cvs".
+
+Don't forget to add your new subdirectory to the INDEX file.