Skip to content

Commit ffff190

Browse files
committed
docs: Fill in the documentation index and re-build the texinfo.
1 parent bed01a1 commit ffff190

File tree

2 files changed

+778
-82
lines changed

2 files changed

+778
-82
lines changed

docs/source/index.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,37 @@
11
Turtles
22
=======
33

4-
TODO
4+
Turtles is an Emacs elisp package that helps write ERT-based tests
5+
that check how Emacs renders buffers and windows. The ERT tests can be
6+
run interactively or in batch mode. You'll find the source code of
7+
this package on https://github.com/szermatt/turtles
8+
9+
Go to :ref:`tut` to get started.
10+
11+
Turtles is especially suited to test:
12+
13+
- the effect of display, before-string, after-string text properties
14+
15+
- the effect of overlays
16+
17+
- text visibility
18+
19+
- mode lines
20+
21+
- complex minibuffer interactions
22+
23+
*This program is free software: you can redistribute it and/or
24+
modify it under the terms of the GNU General Public License as
25+
published by the Free Software Foundation; either version 3 of the
26+
License, or (at your option) any later version.*
27+
28+
*This program is distributed in the hope that it will be useful,
29+
but WITHOUT ANY WARRANTY; without even the implied warranty of
30+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31+
General Public License for more details.*
32+
33+
*You should have received a copy of the GNU General Public License
34+
along with this program. If not, see* http://www.gnu.org/licenses/
535

636
Contents
737
--------

0 commit comments

Comments
 (0)