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 | 74 ----------------------------------------------------- README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 74 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index b50186d2..00000000 --- a/README +++ /dev/null @@ -1,74 +0,0 @@ -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: -- php installer/index.php [-h host] [-u user] [-p pass] [-d dbname] - - Command line parameters: - -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 gallery3 FAQ http://codex.galleryproject.org/Gallery3:FAQ - - Post to the Gallery 3 forums: http://galleryproject.org/forum/96 - - Email gallery-devel@lists.sourceforge.net - 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(+) 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