1 # slides - A terminal slide presenter
   2 
   3 Slides is a simple terminal application that uses [btui](https://github.com/bruce-hill/btui).
   4 
   5 ## Running
   6 
   7 To run the slides program from this directory, run this command to set up a
   8 python virtual environment with the necessary requirements:
   9 
  10 ```
  11 make virtualenv
  12 ```
  13 
  14 Then, you can view a markdown file by running `./slides.py sample.md`
  15 
  16 ## Building
  17 
  18 If you want to create a standalone executable that can be installed, run:
  19 
  20 ```
  21 make
  22 ```
  23 
  24 ...which will build a standalone executable file called `./dist/slides/slides`
  25 
  26 ## Installing
  27 
  28 To install, run `make install` or `make PREFIX=/usr/local install` if you want
  29 to install to a location other than `~/.local/bin`.