Skip to content

Commit abb4382

Browse files
committed
Update README for inclusion in release archives
1 parent dc28df8 commit abb4382

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Contributing to lua-filters
33

44
Happy to have you here! Below you can find guidance on the
55
best way to contribute to this collection of Lua filters.
6-
All contributions are welcome!
6+
Contributions are welcome!
77

88
Bugs reports and feature requests
99
---------------------------------

README.md

+7-15
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,11 @@
55
[GitHub Actions badge]: https://img.shields.io/github/workflow/status/pandoc/lua-filters/CI?logo=github
66
[GitHub Actions]: https://github.com/pandoc/lua-filters/actions
77

8-
This repository collects Lua filters for pandoc.
8+
A collection of Lua filters for pandoc.
99

10-
To learn about Lua filters, see the
11-
[documentation](http://pandoc.org/lua-filters.html).
10+
To learn about Lua filters, see the [documentation].
1211

13-
Structure
14-
---------
15-
16-
Each filter goes in its own subdirectory. Each subdirectory contains:
17-
18-
- the filter itself (e.g. `wordcount.lua`)
19-
- a `README.md` describing the use of the filter
20-
- a `Makefile` with a `test` target to test the filter
21-
- some data files used for the tests, which may also serve
22-
as examples
12+
[documentation]: http://pandoc.org/lua-filters.html
2313

2414
Requirements
2515
------------
@@ -30,8 +20,10 @@ is no guarantee that filters will work with older versions, but
3020
many do.
3121

3222
Some filters depend on external programs, which must be installed
33-
separately. Refer to the filters' README for detailed
34-
requirements.
23+
separately. Refer to the filters' README for detailed
24+
requirements; the filter READMEs are not included in the release
25+
archives, but available online at
26+
<https://github.com/pandoc/lua-filters>.
3527

3628
Contributing
3729
------------

0 commit comments

Comments
 (0)