summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharlotte Koch <dressupgeekout@gmail.com>2023-02-16 16:44:34 -0800
committerCharlotte Koch <dressupgeekout@gmail.com>2023-02-16 16:44:34 -0800
commit758952605ea8cb1b7cf926076f591007d8d98b7e (patch)
tree2ac581d31045011899a312efeb849f3540b3187a /README.md
First commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..887a479
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# WilloraPDF
+
+**WilloraPDF** is a free and open source document preparation system for
+professional publishing.
+
+It is a collection of themes, tools and other goodies for
+[Asciidoctor-PDF][]. **WilloraPDF is designed to empower self-publishers**
+and lower the barrier to entry for authors who want their work
+professionally printed.
+
+It is currently a **work in progress,** being developed alongside my debut
+novel. Version 1.0 of WilloraPDF will be released when the first paperback
+and/or hardcover editions are printed for my book! Then you'll know for certain
+that WilloraPDF _can_ be used to publish actual, real-life books.
+
+
+## Use cases
+
+- Typesetting for printed text with no (or very few) illustrations
+- Render PDFs for local home printing or actual bookbinding
+- Generate properly formatted manuscripts
+
+
+## How it works
+
+1. Write your book in the [AsciiDoc][] markup language
+2. Choose a theme, trim size and other settings
+3. Feed your book into WilloraPDF
+4. A good-looking PDF document comes out!
+
+
+[Asciidoctor]: https://asciidoctor.org/
+[Asciidoctor-PDF]: https://docs.asciidoctor.org/pdf-converter/latest/