diff --git a/README.md b/README.md new file mode 100644 index 000000000..dac51c206 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +SeedDMS is a PHP base Document Management System. For more information +check the web site at https://www.seeddms.org + +There are detailed installation instructions from a preconfigured distribution +at [doc/README.Install.md] + +If you prefer to install from git, you will need to: + +1. Create a directory, e.g. seeddms + `mkdir seeddms` +2. Change into that directory + `cd seeddms` +3. Clone the various SeedDMS repositories + `git clone https://codeberg.org/SeedDMS/preview.git` + `git clone https://codeberg.org/SeedDMS/lucene.git` + `git clone https://codeberg.org/SeedDMS/ѕqlitefts.git` + `git clone https://codeberg.org/SeedDMS/http_webdav_server.git` +4a. For SeedDMS 5.1.x + `git clone -b seeddms-5.1.x https://codeberg.org/SeedDMS/seeddms.git` + `git clone -b seeddms-5.1.x https://codeberg.org/SeedDMS/core.git` +4b. For SeedDMS 6.0.x + `git clone -b seeddms-6.0.x https://codeberg.org/SeedDMS/seeddms.git` + `git clone -b seeddms-6.0.x https://codeberg.org/SeedDMS/core.git` +5. Run composer + `composer update` +6a. Create an installable distribution + `vendor/bin/phing -Dversion=$(php -r 'include "inc/inc.Version.php"; echo (new SeedDMS_Version())->version();') package` +6b. Create an installable version with softlinks + `vendor/bin/phing -Dversion=$(php -r 'include "inc/inc.Version.php"; echo (new SeedDMS_Version())->version();') -Dmode=development package` +