commit 940695c2567db3e848139af652c2ad09dc219991
parent 167303da0312fe15d871755f6ad03bc96d002af9
Author: ugrnm <ultrageranium@bleu255.com>
Date: Thu, 19 Jun 2025 15:40:55 +0200
readme formatting
Diffstat:
| M | README | | | 87 | +++++++++++++++++++++++++++++++++++++++++-------------------------------------- |
1 file changed, 45 insertions(+), 42 deletions(-)
diff --git a/README b/README
@@ -7,25 +7,26 @@ A simple LAN/WLAN screen public http broadcasting service.
motivation
----------
-I've been in situations of giving a lecture or a workshop where there was no
-screen or projector available, or... No cable. The usual workaround that I've
-seen friends and colleagues use is to have everyone join jitsi/zoom/bbb/etc and
-do the screen sharing there. This works but feels like a grotesque variation of
-the "a multinational corporation's service as the easiest way of copying files
-between two nearby devices" entry from the crappy everyday tech bingo.
-
-So here is a response with television, a simple binary that takes screenshots
-of your desktop at regular intervals and serves the result over http on an
-amazingly well formatted html page that can be accessed by everyone over
-LAN/WLAN with their browser. It's *not* a video stream, it's really a 1fps
-style screensharing web thing which is plenty enough for slides, GUI/TUI/CLI
-action, etc.
-
-Of course I hear you say, "OK but then we have all these extra screens now!".
-Well true, but think about the new creative setups you can come up with, not
-everyone needs to have their own screen ffs! Take that as an opportunity to
-completely rearrange the room. Make small groups, I don't know. You can do it,
-I have faith in you.
+I've been in situations of giving a lecture or a workshop where there
+was no screen or projector available, or... No cable. The usual
+workaround that I've seen friends and colleagues use is to have everyone
+join jitsi/zoom/bbb/etc and do the screen sharing there. This works but
+feels like a grotesque variation of the "a multinational corporation's
+service as the easiest way of copying files between two nearby devices"
+entry from the crappy everyday tech bingo.
+
+So here is a response with television, a simple binary that takes
+screenshots of your desktop at regular intervals and serves the result
+over http on an amazingly well formatted html page that can be accessed
+by everyone over LAN/WLAN with their browser. It's *not* a video stream,
+it's really a 1fps style screensharing web thing which is plenty enough
+for slides, GUI/TUI/CLI action, etc.
+
+Of course I hear you say, "OK but then we have all these extra screens
+now!". Well true, but think about the new creative setups you can come
+up with, not everyone needs to have their own screen ffs! Take that as
+an opportunity to completely rearrange the room. Make small groups, I
+don't know. You can do it, I have faith in you.
firefox, chrome, chromium, edge: works great (desktop and mobile)
safari: does not work at all, *boooo* *throws stuff at safari*
@@ -52,13 +53,13 @@ television [options]
-idle user activity detection (default off)
- Only works with X, makes use of X11 Screen Saver extension.
- By default, television will make a new screenshot every 2 seconds.
- This will work everywhere but is quite wasteful, when -idle is used
- screnshots are made only when user activity is detected. As a bonus,
- it means that the clients will reuse of the last cached image when
- there is no activity, therefore reducing drastically the network
- traffic too!
+ Only works with X, makes use of X11 Screen Saver extension. By
+ default, television will make a new screenshot every 2 seconds.
+ This will work everywhere but is quite wasteful, when -idle is
+ used screnshots are made only when user activity is detected. As
+ a bonus, it means that the clients will reuse of the last cached
+ image when there is no activity, therefore reducing drastically
+ the network traffic too!
-port http port number (default 8888)
@@ -67,19 +68,19 @@ television [options]
By default, television relies on kbinani/screenshot for taking a
screenshot and pixiv/go-libjpeg for generating a jpg. This should
work everywhere, however there can be more effective and efficient
- ways to take the screenshot (see examples), or it could be interesting
- to process the image before serving it. With -snap the whole mechanism
- for taking the screenshot, saving it as jpeg and placing it in the
- www folder is skipped and will be replace by your very own (TM)
- shell oneliner, assuming you have a working sh. Have fun. You deserve
- it.
+ ways to take the screenshot (see examples), or it could be
+ interesting to process the image before serving it. With -snap the
+ whole mechanism for taking the screenshot, saving it as jpeg and
+ placing it in the www folder is skipped and will be replace by
+ your very own (TM) shell oneliner, assuming you have a working sh.
+ Have fun. You deserve it.
-www www directory (default "./www")
By default, television will look for the www folder in the same
folder from which television is executed, this is far from ideal.
- I'm sure you have better ideas. I will suggest one in the examples
- section.
+ I'm sure you have better ideas. I will suggest one in the
+ examples section.
client shortcut
@@ -94,8 +95,8 @@ examples
What does this do?
-It just werks. Just run it like this from the git folder (after building it),
-and ask everyone to join http://your.local.ip.address:8888/tv
+It just werks. Just run it like this from the git folder (after building
+it), and ask everyone to join http://your.local.ip.address:8888/tv
---
@@ -116,13 +117,14 @@ television \
What does this do?
--snap "scrot etc" replaces the builtin screenshot and jpeg encoding by scrot
- and this is to my knowledge the fastest and most efficient
- way to take screenshots on X. See HACKING for non-X feels.
+-snap "scrot etc" replaces the builtin screenshot and jpeg encoding by
+ scrot and this is to my knowledge the fastest and most
+ efficient way to take screenshots on X. See HACKING for
+ non-X feels.
-www /tmp/www uses /tmp/www as root directory for serving the files.
- on systems where /tmp is in fact tmpfs this is a good idea
- because this could save a lot of disk write access.
+ on systems where /tmp is in fact tmpfs this is a good
+ idea because this could save a lot of disk write access.
-idle takes a screenshots only when user activity is detected,
namely keyboard input or mouse movement. Shh. Don't move.
@@ -137,4 +139,5 @@ What does this do?
What does this do?
--snap "import etc" this is now a lowtechmag presentation <3
+-snap "import etc" this is now a lowtechmag presentation :)
+
