From d449eabe7f0638454d340640aa143e4be71818ac Mon Sep 17 00:00:00 2001 From: Jozef Selesi Date: Tue, 5 Mar 2013 10:17:00 +0100 Subject: Convert README to Markdown. --- README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 00000000..a49bfb03 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +Gallery 3.0+ (development version) +================================== + +About +----- + +Gallery 3 is a web based software product that lets you manage your +photos on your own website. You must have your own website with PHP +and database support in order to install and use it. With Gallery you +can easily create and share albums of photos via an intuitive +interface. + +Intended Audience +----------------- + +This version is intended for anybody who has a website. We stand +ready to support the product and help you to make the most of it. We +welcome theme and module developers to play with this release and +start turning out slick new designs for our happy users. If you have +questions or problems, you can get help in the Gallery forums: + + http://galleryproject.org/forum/96 + +Security +-------- + +We've contracted a professional security audit, received their results +and resolved all the issues they found. + +Did you find a security flaw? Please email security@galleryproject.org +with the details and we'll fix it ASAP! + +Supported Configuration +----------------------- + + - Platform: Linux / Unix. + - Web server: Apache 2.2 and newer. + - PHP 5.2.3 and newer (PHP's safe_mode must be disabled and simplexml, + filter, and json must be installed). + - Database: MySQL 5 and newer. + +For complete system requirements, please refer to: + + http://codex.galleryproject.org/Gallery3:Requirements + +Installing and Upgrading Instructions +------------------------------------- + +For comprehensive instructions, The online User Guide is your best resource: + + http://codex.galleryproject.org/Gallery3:User_guide + +There are also simple instructions below. **NOTE:** You can upgrade from +beta 1 and beyond, but not from alpha releases. + +### Installation via the web + +Point your web browser at `gallery3/installer/` and follow the +instructions. + +### Installation from the command line + +```sh +php installer/index.php [-h host] [-u user] [-p pass] [-d dbname] +``` + Command line parameters: + +```sh + -h Database host (default: localhost) + -u Database user (default: root) + -p Database user password (default: ) + -d Database name (default: gallery3) + -x Table prefix (default: ) +``` + +Bugs? +----- + +Go to http://apps.sourceforge.net/trac/gallery/ click the "login" link +and log in with your SourceForge username and password, then click the +"new ticket" button. + +Questions, Problems +------------------- + + - Check out the Gallery 3 FAQ: http://codex.galleryproject.org/Gallery3:FAQ + - Post to the Gallery 3 forums: http://galleryproject.org/forum/96 + - Email gallery-devel@lists.sourceforge.net -- cgit v1.2.3 From ef1ae582bb1997cc91d9936d81e4821b74abe3b1 Mon Sep 17 00:00:00 2001 From: Jozef Selesi Date: Tue, 5 Mar 2013 10:17:22 +0100 Subject: Add Travis CI build status badge to README. --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a49bfb03..fbe87ea6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Gallery 3.0+ (development version) ================================== +[![Build Status](https://travis-ci.org/gallery/gallery3.png?branch=master)](https://travis-ci.org/gallery/gallery3) + About ----- -- cgit v1.2.3 From e8552f4e61cadf98f5f303a3be621f960f2afdf4 Mon Sep 17 00:00:00 2001 From: Jozef Selesi Date: Thu, 7 Mar 2013 00:10:36 +0100 Subject: Add newline after code block so packaging doesn't complain. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index fbe87ea6..a10fd672 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ instructions. ```sh php installer/index.php [-h host] [-u user] [-p pass] [-d dbname] ``` + Command line parameters: ```sh -- cgit v1.2.3 From cd83b06ab053bde422d59a10081092e160800cf7 Mon Sep 17 00:00:00 2001 From: shadlaws Date: Thu, 7 Mar 2013 10:11:14 +0100 Subject: Update README.md to say 3.1+ instead of 3.0+. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index a10fd672..d84a5453 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Gallery 3.0+ (development version) +Gallery 3.1+ (development version) ================================== [![Build Status](https://travis-ci.org/gallery/gallery3.png?branch=master)](https://travis-ci.org/gallery/gallery3) -- cgit v1.2.3