aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..673fc966a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+[![Piwigo](http://piwigo.org/screenshots/logos/piwigo@280.png)](http://piwigo.org)
+---------
+
+Piwigo is photo gallery software for the web, built by an active community of users and developers.
+
+Extensions make Piwigo easily customizable. Icing on the cake, Piwigo is free and open source.
+
+![screenshot](http://piwigo.org/screenshots/github-screenshot.jpg)
+
+ * [piwigo.org](http://piwigo.org)
+ * [Demo](http://piwigo.org/demo)
+ * [Downloads](http://piwigo.org/basics/downloads)
+ * [User guide](http://piwigo.org/doc)
+ * [Plugins and themes](http://piwigo.org/ext)
+ * [Forum](http://piwigo.org/forum)
+ * [News](http://piwigo.org/news)
+
+## Requirements
+
+ * A webserver (Apache or nginx recommended)
+ * PHP 5.2 or greater
+ * MySQL 5 or greater or MariaDB equivalent
+ * ImageMagick (recommended) or PHP GD
+
+## Quick start install
+
+### NetInstall
+
+ * Download the [NetInstall script](http://piwigo.org/download/dlcounter.php?code=netinstall)
+ * Transfer the script to your web space with any FTP client
+ * Open the script in you web browser (for example http://example.com/piwigo-netinstall.php) and follow the steps
+
+[More information](http://piwigo.org/basics/installation_netinstall)
+
+### Manual
+
+ * Download the [latest stable version](http://piwigo.org/download/dlcounter.php?code=latest) and unzip it
+ * Transfer everything to your web space with any FTP client
+ * Open your website (for example http://example.com/piwigo) and follow the steps
+
+[More information](http://piwigo.org/basics/installation_manual)
+
+If you do not have your own server, consider the [piwigo.com](http://piwigo.com/) hosting solution.
+
+## Contributing
+
+Piwigo is widely driven by its community; if you want to improve the code, fork this repo and submit your changes to the `master` branch.
+
+## License
+
+Piwigo is released under the GPL v2 license.
+