README
1=========
2WebHelper
3=========
4
5.. contents::
6
7
8About
9=====
10
11WebHelper is a plugin for Geany that provides some web development facilities,
12such as a web page preview and some debugging tools (web inspector).
13
14
15Prominent features
16------------------
17
18* A basic web view, allowing to display any web page (using WebKit);
19* Possible automatic reloading of the web view upon document saving;
20* A web inspector/debugging tool for the web view's content (including a
21 JavaScript console, a viewer and editor of processed HTML and CSS, a network
22 usage analysis tool and many more, thanks to WebKit);
23* Basic bookmarks for quicker access to frequently used URL.
24
25
26Requirements
27============
28
29This plugin requires GTK+ (>= 2.16), GLib (>= 2.16), GIO (>= 2.18),
30GdkPixbuf (>= 2.0), WebKitGTK (>= 1.1.18), and obviously Geany (>= 0.20) to
31work. If you intend to build it yourself, you will need to get the development
32files of these libraries. You can find these packages at http://www.geany.org/,
33http://www.gtk.org/ and http://www.webkitgtk.org/.
34
35
36Installation
37============
38
39For detailed instructions, see the INSTALL file of the Geany-Plugins package
40this plugin is part of.
41
42
43Usage
44=====
45
46When loaded into Geany, this plugins adds a web view in the message window
47(the default), the sidebar or in a separate window. You can find most of the
48features from this view.
49
50Bookmarks
51---------
52
53To add a bookmark, you can click on the website's icon next to its URL and
54check the "Bookmark this website" item. You can alternatively use the
55configurable keybinding to toggle the bookmark for the current URL.
56
57Bookmarks are displayed in the drop-down menu of the URL bar, sorted
58alphabetically by domain.
59
60
61License
62=======
63
64WebHelper is distributed under the terms of the GNU General Public License
65as published by the Free Software Foundation, either version 3 of the
66License, or (at your option) any later version. You should have received a copy
67of the GNU General Public License along with WebHelper. If not, see
68<http://www.gnu.org/licenses/>.
69
70
71Contact
72=======
73
74You can email me at <ban(at)herbesfolles(dot)org>, and I may also be on the
75#geany channel on FreeNode, under the `b4n` nickname.
76
77
78Bug reports and feature requests
79--------------------------------
80
81To report a bug or ask for a new feature, please use the Geany-Plugins tracker
82on GitHub: https://github.com/geany/geany-plugins/issues
83