aboutsummaryrefslogtreecommitdiff
path: root/.repos/sent/README.md
diff options
context:
space:
mode:
authorMarvin Borner2020-06-11 14:53:23 +0200
committerMarvin Borner2020-06-11 14:53:23 +0200
commitcfc61f4fa5a5b2236439ec1ebe416f23e31d8092 (patch)
tree96f4fd5f4d57e6835dd6f105caca30c65d7160e5 /.repos/sent/README.md
parentd05b17617eb83377f980c24f29079229697504cc (diff)
Soo many features added
weeee so much efficiencyyyy
Diffstat (limited to '.repos/sent/README.md')
-rw-r--r--.repos/sent/README.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/.repos/sent/README.md b/.repos/sent/README.md
new file mode 100644
index 0000000..c1e9385
--- /dev/null
+++ b/.repos/sent/README.md
@@ -0,0 +1,59 @@
+sent is a simple plaintext presentation tool.
+
+sent does not need latex, libreoffice or any other fancy file format, it uses
+plaintext files to describe the slides and can include images via farbfeld.
+Every paragraph represents a slide in the presentation.
+
+The presentation is displayed in a simple X11 window. The content of each slide
+is automatically scaled to fit the window and centered so you also don't have to
+worry about alignment. Instead you can really concentrate on the content.
+
+
+Dependencies
+
+You need Xlib and Xft to build sent and the farbfeld[0] tools installed to use
+images in your presentations.
+
+Demo
+
+To get a little demo, just type
+
+ make && ./sent example
+
+You can navigate with the arrow keys and quit with `q`.
+
+
+Usage
+
+ sent [FILE]
+
+If FILE is omitted or equals `-`, stdin will be read. Produce image slides by
+prepending a `@` in front of the filename as a single paragraph. Lines starting
+with `#` will be ignored. A `\` at the beginning of the line escapes `@` and
+`#`. A presentation file could look like this:
+
+ sent
+
+ @nyan.png
+
+ depends on
+ - Xlib
+ - Xft
+ - farbfeld
+
+ sent FILENAME
+ one slide per paragraph
+ # This is a comment and will not be part of the presentation
+ \# This and the next line start with backslashes
+
+ \@FILE.png
+
+ thanks / questions?
+
+
+Development
+
+sent is developed at http://tools.suckless.org/sent
+
+
+0: http://tools.suckless.org/farbfeld/