]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/ggtags/README.rst
Merge branch 'master' of github.com:leoliu/ggtags
[gnu-emacs-elpa] / packages / ggtags / README.rst
index f00d69beae7751b351044a8f02f81b2a4f74d959..fc0b9bb3545835266a65de02119c91b964307749 100644 (file)
@@ -8,8 +8,9 @@ list-packages``) and is also available on `MELPA
 
 The goal is to make working with GNU Global in Emacs as effortlessly
 and intuitively as possible and to integrate tightly with standard
-emacs packages. ``ggtags.el`` is tested in emacs 24.1, 24.2, 24.3 and
-trunk. Patches, feature requests and bug reports are welcome. Thanks.
+emacs packages. ``ggtags.el`` is tested in emacs 24.1, 24.2, 24.3,
+24.4 and trunk. Patches, feature requests and bug reports are welcome.
+Thanks.
 
 Features
 ~~~~~~~~
@@ -39,9 +40,9 @@ Features
 Screenshot
 ~~~~~~~~~~
 
-.. figure:: http://i.imgur.com/LX7PVc3.png
+.. figure:: http://i.imgur.com/wx8ZPGe.png
    :width: 500px
-   :target: http://i.imgur.com/LX7PVc3.png
+   :target: http://i.imgur.com/wx8ZPGe.png
    :alt: ggtags.png
 
 Why GNU Global
@@ -55,27 +56,36 @@ Install Global and plugins
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 1. Compile and install Global with ``exuberant-ctags``
-::
+   ::
 
-   ./configure --prefix=<PREFIX> --with-exuberant-ctags=/usr/local/bin/ctags
-   make && make install
+     ./configure --prefix=<PREFIX> --with-exuberant-ctags=/usr/local/bin/ctags
+     make && make install
 
-The executable ``ctags`` is unfortunately named because ``emacs`` also
-includes a command of the same name. So make sure it is from
-http://ctags.sourceforge.net. See ``plugin-factory/README`` in GNU
-Global source for further information.
+   The executable ``ctags`` is unfortunately named because ``emacs`` also
+   includes a command of the same name. So make sure it is from
+   http://ctags.sourceforge.net. See ``plugin-factory/README`` in GNU
+   Global source for further information.
 
 2. Install ``pygments`` plugin
-::
 
-   pip install pygments
-   git clone https://github.com/yoshizow/global-pygments-plugin.git
-   sh reconf.sh
-   ./configure --prefix=<PREFIX> --with-exuberant-ctags=/usr/local/bin/ctags
-   make && make install
-   cp sample.globalrc $HOME/.globalrc
+   The ``pygments`` plugin has been included in ``global`` since
+   version ``6.3.2``. ``pip install pygments`` is the only step
+   required. Note the plugin is not activated by the default
+   ``gtags.conf`` or ``.globalrc``. See
+   ``global/plugin-factory/PLUGIN_HOWTO.pygments`` for details.
 
-Make sure the value of ``<PREFIX>`` agree with step 1.
+   The following instructions are for older ``global``.
+   ::
+
+     pip install pygments
+     git clone https://github.com/yoshizow/global-pygments-plugin.git
+     cd global-pygments-plugin/
+     sh reconf.sh
+     ./configure --prefix=<PREFIX> --with-exuberant-ctags=/usr/local/bin/ctags
+     make && make install
+     cp sample.globalrc $HOME/.globalrc
+
+   Make sure the value of ``<PREFIX>`` agree with step 1.
 
 Config
 ~~~~~~
@@ -294,6 +304,12 @@ Integration with other packages
 NEWS
 ~~~~
 
+[2014-09-12 Fri] 0.8.6
+++++++++++++++++++++++
+
+#. ``ggtags-show-definition`` shows definition with font locking.
+
+
 [2014-06-22 Sun] 0.8.5
 ++++++++++++++++++++++