update changelog and release version 0.4.0

[phancap.git] / README.rst

diff --git a/README.rst b/README.rst
index ca063f16042ed9b55ec33bd8c5f3242bef48f769..818eafd8f85835e7178f522b1861144a40237142 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -26,6 +26,10 @@ Features
 * JPG, PNG and PDF output (PDFs are searchable)
 * Authentication
 * Can run on a normal web server without GUI. See dependencies_.
 * JPG, PNG and PDF output (PDFs are searchable)
 * Authentication
 * Can run on a normal web server without GUI. See dependencies_.

+* Generated images get meta data embedded:
+
+  * URL of captured page
+  * Capture settings

 
 
 .. note::
 
 
 .. note::


@@ -43,10 +47,15 @@ Basic setup
 ===========
 #. Download the ``.phar`` file and put it onto your web server
 #. Open the phar file in your browser
 ===========
 #. Download the ``.phar`` file and put it onto your web server
 #. Open the phar file in your browser

+
+   If you only see text beginning with ``<?php``, you need to
+   `setup .phar file extension handling`__ in your web server first.

 #. Click the "setup check" link
 #. Fix all errors that are reported
 #. Run ``phancap.phar/get.php?url=cweiske.de`` and see the screenshot
 
 #. Click the "setup check" link
 #. Fix all errors that are reported
 #. Run ``phancap.phar/get.php?url=cweiske.de`` and see the screenshot
 

+__ http://cweiske.de/tagebuch/phar-webserver.htm
+

 
 Advanced setup
 ==============
 
 Advanced setup
 ==============


@@ -265,6 +274,7 @@ Dependencies
 - External tools:
 
   - `cutycapt <http://cutycapt.sourceforge.net/>`_
 - External tools:
 
   - `cutycapt <http://cutycapt.sourceforge.net/>`_

+  - `exiftool <http://owl.phy.queensu.ca/~phil/exiftool/>`_

   - `imagemagick's <http://www.imagemagick.org/>`_ ``convert``
   - ``xvfb-run``
 
   - `imagemagick's <http://www.imagemagick.org/>`_ ``convert``
   - ``xvfb-run``
 


@@ -273,7 +283,10 @@ Dependencies
   - PEAR's ``System.php``
 
 
   - PEAR's ``System.php``
 
 

-=======
+=============
+About phancap
+=============
+

 License
 =======
 ``phancap`` is licensed under the `AGPL v3`__ or later.
 License
 =======
 ``phancap`` is licensed under the `AGPL v3`__ or later.


@@ -281,7 +294,6 @@ License
 __ http://www.gnu.org/licenses/agpl.html
 
 
 __ http://www.gnu.org/licenses/agpl.html
 
 

-========

 Homepage
 ========
 Web site
 Homepage
 ========
 Web site


@@ -293,7 +305,6 @@ Source code
    Mirror: https://github.com/cweiske/phancap
 
 
    Mirror: https://github.com/cweiske/phancap
 
 

-======

 Author
 ======
 Written by Christian Weiske, cweiske@cweiske.de
 Author
 ======
 Written by Christian Weiske, cweiske@cweiske.de


@@ -306,3 +317,17 @@ All of those are open source:
 
 * http://code.google.com/p/browsershots/ (python)
 * https://github.com/gre/screenshot-webservice (scala)
 
 * http://code.google.com/p/browsershots/ (python)
 * https://github.com/gre/screenshot-webservice (scala)

+
+
+===========
+Development
+===========
+
+Releasing a new version
+=======================
+
+#. Update ``ChangeLog``
+#. Change version number in ``build.xml``
+#. Run ``phing``
+#. Deploy the new files in ``dist/``
+#. Tag the new version in git