sent

simple plaintext presentation tool
git clone git://git.suckless.org/sent
Log | Files | Refs | README | LICENSE

README.md (1404B)


      1 sent is a simple plaintext presentation tool.
      2 
      3 sent does not need latex, libreoffice or any other fancy file format, it uses
      4 plaintext files to describe the slides and can include images via farbfeld.
      5 Every paragraph represents a slide in the presentation.
      6 
      7 The presentation is displayed in a simple X11 window. The content of each slide
      8 is automatically scaled to fit the window and centered so you also don't have to
      9 worry about alignment. Instead you can really concentrate on the content.
     10 
     11 
     12 Dependencies
     13 
     14 You need Xlib and Xft to build sent and the farbfeld[0] tools installed to use
     15 images in your presentations.
     16 
     17 Demo
     18 
     19 To get a little demo, just type
     20 
     21 	make && ./sent example
     22 
     23 You can navigate with the arrow keys and quit with `q`.
     24 
     25 
     26 Usage
     27 
     28 	sent [FILE]
     29 
     30 If FILE is omitted or equals `-`, stdin will be read. Produce image slides by
     31 prepending a `@` in front of the filename as a single paragraph. Lines starting
     32 with `#` will be ignored. A `\` at the beginning of the line escapes `@` and
     33 `#`. A presentation file could look like this:
     34 
     35 	sent
     36 	
     37 	@nyan.png
     38 	
     39 	depends on
     40 	- Xlib
     41 	- Xft
     42 	- farbfeld
     43 	
     44 	sent FILENAME
     45 	one slide per paragraph
     46 	# This is a comment and will not be part of the presentation
     47 	\# This and the next line start with backslashes
     48 	
     49 	\@FILE.png
     50 	
     51 	thanks / questions?
     52 
     53 
     54 Development
     55 
     56 sent is developed at http://tools.suckless.org/sent
     57 
     58 
     59 0: http://tools.suckless.org/farbfeld/