catpoint

Catpoint simple presenting software.
git clone git://r-36.net/catpoint
Log | Files | Refs | README | LICENSE

README.md (1229B)


      1 # Synopsis
      2 
      3 Catpoint  is  a  simple viewer of text files written in curses.  Further
      4 documentation comes in a series of slides.  Just do:
      5 
      6     $ make && ./catpoint showoff/*.txt
      7 
      8 ## Slide Effects
      9 
     10 If you want to have some effects between slides, you can run a script or
     11 application. The argument to catpoint needs to be some executable file.
     12 
     13 An example for how to do this is:
     14 
     15     $ catpoint-wrap showoff/random-animation.sh showoff/*.txt
     16 
     17 You will need terminaltexteffects from:
     18 
     19     https://github.com/ChrisBuilds/terminaltexteffects
     20     $ pip install --user terminaltexteffects
     21 
     22 ## Pointtools
     23 
     24 Check out
     25 
     26 	git://bitreich.org/pointtools
     27 
     28 How to easily create a presentation for catpoint from some md file is then:
     29 
     30 	% $EDITOR presentation.md
     31 	% cat presentation.md | md2point
     32 	% catpoint *.txt
     33 
     34 Or simply:
     35 
     36 	% dir2point
     37 
     38 This will greatly speed up your productivity.
     39 
     40 ## Usage
     41 
     42     catpoint file.txt
     43 
     44 ## License
     45 
     46 In  2017  I  simply  took over catpoint and relicensed it under GPLv3 to
     47 protect it against military and villain Open Source  customers.  If  the
     48 original  author does not like this, contact me at my e‐mail address and
     49 will find a solution.
     50 
     51 ## Bugs
     52 
     53 Send them to
     54 
     55 	Christoph Lohmann <20h@r-36.net>
     56 
     57 Have fun!
     58