commit 54a10c0da824b06660d08cb43d9bfbc14f6bbac3
parent 6d19070b5d5e0ef0cf451a455530284f4e5a6c3e
Author: Timo A. Hummel <timo@netraver.de>
Date: Thu, 26 May 2011 01:58:37 +0200
Added README file
Diffstat:
A | README.md | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
1 file changed, 38 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+README
+======
+
+What is PartDB2?
+----------------
+
+PartDB2 is a project to manage an inventory of electronic parts. Usually, electronic geeks have a lot of electronic
+components, and have trouble finding them.
+
+Project Status
+--------------
+
+This project is currently in pre-alpha stage. The code is currently pretty messy, there's not much documentation so far.
+Also please note that this project uses components I've used in earlier projects, which are based on earlier projects...
+you get the point.
+
+Demo Site
+---------
+
+To test everything which has been written so far, please visit http://partdb2.felicitus.org for a demo which is built
+from the git sources once an hour.
+
+Requirements
+------------
+
+PartDB2 needs:
+* PHP 5.3.2 and up
+* APC (see http://www.php.net/manual/en/apc.installation.php how to install it)
+* SOAP
+* Tokenizer Support
+* A working PEAR installation
+* A MySQL database
+
+Installation
+------------
+
+Since this project is work-in-progress, please refer to the INSTALL document on how to install PartDB2.+
\ No newline at end of file