better README

This commit is contained in:
Joshua Seigler 2017-01-23 10:50:32 -05:00
parent 2a2344add1
commit 1fef6dd85b

View file

@ -1,22 +1,7 @@
#JANUS
# [Show presentation](https://seigler.github.io/presentation-blockchains/)
This is a browser-based presentation framework with two connected views: one for the presenter, and one for the audience.
Hotkeys:
[See it in action!](https://seigler.github.io/janus)
## Features:
* Presenter view and presentation view, connected through Localstorage
* Specializes in live-coding demos
## How to Use:
Use `npm run start` to serve the project folder on `localhost` and launch it in your default browser.
After you have edited index.html to your liking, you can run `npm run build` to compile the whole presentation into a single portable file for use elsewhere.
## Gotchas:
Firefox and Chrome handle `file:///` urls differently. In Firefox, local files are allowed to interact with LocalStorage, but on Chrome they are not. To circumvent this issue in Chrome, you have to serve the file on `localhost` with `npm run start` or some other local server.
Currently the live editor completely blows up in Firefox. I think it's related to a flexbox bug?
* <kbd>Page Up</kbd> / <kbd>Page Down</kbd> to move through slides.
* <kbd>Esc</kbd> to see commands list
* <kbd>Esc</kbd>, <kbd>p</kbd> for presenter mode