summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBharat Mediratta <bharat@menalto.com>2013-03-05 08:47:52 -0800
committerBharat Mediratta <bharat@menalto.com>2013-03-05 08:47:52 -0800
commite630ab9bdc45cbb9ebd7db8fd280cb898fe6f291 (patch)
treec252a8aba82634954af4dfba09ccdf680f63dfa0
parent24475e914ffb5f639f35b500e29b2743cf2216c7 (diff)
parentef1ae582bb1997cc91d9936d81e4821b74abe3b1 (diff)
Merge pull request #189 from jozefs/markdown
Convert README to Markdown and show build status badge
-rw-r--r--README.md (renamed from README)48
1 files changed, 32 insertions, 16 deletions
diff --git a/README b/README.md
index b50186d2..fbe87ea6 100644
--- a/README
+++ b/README.md
@@ -1,14 +1,20 @@
Gallery 3.0+ (development version)
+==================================
+
+[![Build Status](https://travis-ci.org/gallery/gallery3.png?branch=master)](https://travis-ci.org/gallery/gallery3)
+
+About
+-----
-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
+-----------------
-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
@@ -17,16 +23,18 @@ questions or problems, you can get help in the Gallery forums:
http://galleryproject.org/forum/96
+Security
+--------
-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
+-----------------------
-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,
@@ -34,41 +42,49 @@ SUPPORTED CONFIGURATION:
- Database: MySQL 5 and newer.
For complete system requirements, please refer to:
+
http://codex.galleryproject.org/Gallery3:Requirements
+Installing and Upgrading Instructions
+-------------------------------------
-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
+There are also simple instructions below. **NOTE:** You can upgrade from
beta 1 and beyond, but not from alpha releases.
+### Installation via the web
-INSTALLATION VIA THE WEB:
-- Point your web browser at gallery3/installer/ and follow the
- instructions.
+Point your web browser at `gallery3/installer/` and follow the
+instructions.
+### Installation from the command line
-INSTALLATION FROM THE COMMAND LINE:
-- php installer/index.php [-h host] [-u user] [-p pass] [-d dbname]
-
+```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?
+-----
-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
+-------------------
-QUESTIONS, PROBLEMS:
- - Check out the gallery3 FAQ http://codex.galleryproject.org/Gallery3:FAQ
+ - 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
-