Skip to content

Commit cb38647

Browse files
author
Weera Wu
committed
Add touch gestures section to README.md
1 parent a29b4e1 commit cb38647

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ A Keynote-inspired presentation app written with Mithril
2525

2626
3. Using a browser, go to `http://localhost:8000` and you'll see example slides.
2727

28-
4. To add or edit slides, make changes to the `slides.json` file and reload your browser.
28+
4. To add or edit slides, make changes to the `slides.json` file and reload your
29+
browser.
2930

3031
## Keyboard shortcuts
3132
Shortcuts for navigating slides are listed below.
@@ -38,25 +39,34 @@ Quit presentation mode | <kbd>Esc</kbd> or <kbd>Q</kbd>
3839
Show or hide the pointer | <kbd>C</kbd>
3940
Change presentation theme | <kbd>T</kbd>
4041

42+
## Touch gestures
43+
Gestures for navigating slides on touchscreen devices.
44+
45+
Action | Gesture
46+
------------------------- | --------------------------------------------
47+
Advance to the next slide | Tap on the right
48+
Go to previous slide | Tap on the left
49+
Change presentation theme | Touch and hold
50+
4151
## Offline mode
42-
mithril-slides requires an internet connection to work. If you are to present in a
43-
place without one. You can still use mithril-slides by checking out `offline` branch
44-
before starting a web server:
52+
mithril-slides requires an internet connection to work. If you are to present in
53+
a place without one. You can still use mithril-slides by checking out `offline`
54+
branch before starting a web server:
4555

4656
$ git checkout offline
4757
$ python -m SimpleHTTPServer 8000 # Python 2
4858
$ python -m http.server 8000 # Python 3
4959

50-
You also need to change src properties of all image and embed objects in your
51-
`slides.json` file to local files.
60+
You also need to point the `src` property of all images and embed objects in
61+
your `slides.json` file to local files.
5262

5363
## Known issues
5464
Some websites can not be embedded because they have secure HTTP headers (either
55-
`X-Frame-Options` or `Content-Security-Policy`) set in their responses. To remove
56-
those headers, you need a browser extension. For Google Chrome, install
65+
`X-Frame-Options` or `Content-Security-Policy`) set in their responses. To
66+
remove those headers, you need a browser extension. For Google Chrome, install
5767
[ModHeader][1] extension and add response headers for above headers with empty
58-
values. For Firefox, install [Modify Response Headers][2] add-on and add filters for
59-
those headers. The following slide can be used to test your setup:
68+
values. For Firefox, install [Modify Response Headers][2] add-on and add filters
69+
for those headers. The following slide can be used to test your setup:
6070

6171
{
6272
"embed": {

0 commit comments

Comments
 (0)