README
1Lipsum
2------
3
4.. contents::
5
6About
7------
8
9Lipsum is a plugin for Geany that implements a Lorem Ipsum
10generator to insert placeholder text into your document.
11
12
13Installation
14------------
15
16This version of the plugin is installed with the combined
17geany-plugins release. Please check README of this package
18and/or https://plugins.geany.org/install.html.
19
20
21Usage
22-----
23
24After installed successfully, load the plugin in Geany's plugin manager
25and a new menu item in the Tools menu will appear.
26
27To insert Lorem Ipsum to your document, either use the appearing menu
28item or use the keystroke which you can configure inside Geany's
29preferences dialog. Inside the dialog you can set up a length of the
30text. Values between 1 and 5000 chars are available here. If you
31choose a length that is not fitting with the length of the Lipsum
32snippet shipped with this plugin it will be repeated and cut so you
33will always get the wished number of chars inserted.
34
35
36Development
37-----------
38
39You can checkout the current source code from the git repository at
40github.com. Get the code by:
41
42git clone https://github.com/geany/geany-plugins.git
43
44If you want to create a patch, please respect the license of
45Lipsum as well as intellectual property of third. Patches that
46should be included to the default distribution must be licensed under
47the same conditions as Lipsum by the copyright owner (GPL2+).
48
49
50Known issues
51------------
52
53At the moment, there is no known issue.
54
55For more recent information reported issues will be tracked at
56https://github.com/geany/geany-plugins/issues
57
58
59License
60-------
61
62Lipsum and all its parts is distributed under the terms of the
63GNU General Public License as published by the Free Software
64Foundation; either version 2 of the License, or (at your option) any
65later version. A copy of this license can be found in the file COPYING
66included with the source code of this program. If not, you will be
67able to get a copy by contacting the Free Software Foundation, Inc.,
6851 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
69
70
71Bugs, questions, bugs, homepage
72-------------------------------
73
74If you found any bugs or want to provide a patch, please contact
75Frank Lanitz (frank(at)geany(dot)org). Please also do so, if you got
76any questions and visiting http://plugins.geany.org didn't help you
77to figure out the answer. Visiting the website is also a good start
78if you want to check for any update on this plugin.
79