~kiddo/knock-clock/main

« back to all changes in this revision

Viewing changes to README.html

  • Committer: Jean-François Fortin Tam
  • Date: 2008-01-31 16:21:46 UTC
  • Revision ID: jeff@khloe-20080131162146-6guvfp00zspv5yj4
Renamed the application to Knock Clock, a much cooler name, ready for 
publication. Also updated the readme file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<h1>Keystroke alarm</h1>
2
 
<p>This application is just a python script that starts playback with mplayer and stops as soon as you hit the keyboard. The goal is to have your computer behave like a real alarm clock that you can hit in the dark :) the time stuff is handled by gnome-schedule, whose job is to launch this script, "keystroke-alarm".</p>
3
 
<p>keystroke-alarm has the following dependencies: mplayer-nogui, gnome-schedule, gnome-terminal, and a working internet connection if you plan to leave the default "TARGET" setting. If your network connection is not available at the Moment of Awakening, keystroke-alam will instead play the terrible Ubuntu saxophone song in /usr/share/example-content/</p>
 
1
<h1>Knock Clock</h1>
 
2
<p>This application is just a python script that starts playback with mplayer and stops as soon as you hit the keyboard. The goal is to have your computer behave like a real alarm clock that you can hit in the dark :) the time stuff is handled by gnome-schedule, whose job is to launch this script, "knock-clock".</p>
 
3
<p>knock-clock has the following dependencies: mplayer-nogui, gnome-schedule, gnome-terminal, and a working internet connection if you plan to leave the default "TARGET" setting. If your network connection is not available at the Moment of Awakening, knock-clock will instead play the terrible Ubuntu saxophone song in /usr/share/example-content/</p>
4
4
 
5
5
<p>To set it up:</p>
6
6
<ol>
7
7
    <li>make sure the dependecies are satisfied: <code>sudo apt-get install mplayer-nogui gnome-terminal gnome-schedule bzr</code></li>
8
 
        <li>dowload this software manually by saving <a href="keystroke-alarm">this file</a>, or by using <code>bzr checkout [this_website_address]</code> (for geeks)</li>
 
8
        <li>dowload this software manually by saving <a href="knock-clock">this file</a>, or by using <code>bzr checkout [this_website_address]</code> (for geeks)</li>
9
9
        <li>open the file and edit the "TARGET" if you want to use a local audio file or playlist of your own. Also change NEED_NETWORK to False if your target is not an Internet radio.</li>
10
 
        <li>move the file (optional): <code>sudo mv keystroke-alarm /usr/bin/keystroke-alarm</code></li>
11
 
        <li>make sure it has executable permissions: <code>sudo chmod +x /usr/bin/keystroke-alarm</code> or <code>chmod +x keystroke-alarm</code></li>
12
 
        <li>set up gnome-schedule to launch "keystroke-alarm" at any desired time. <b>Make sure that the "No output" checkbox is deactivated</b> (otherwise the terminal will not be visible).</li>
 
10
        <li>move the file (optional): <code>sudo mv knock-clock /usr/bin/knock-clock</code></li>
 
11
        <li>make sure it has executable permissions: <code>sudo chmod +x /usr/bin/knock-clock</code> or <code>chmod +x knock-clock</code></li>
 
12
        <li>set up gnome-schedule to launch "knock-clock" at any desired time. <b>Make sure that the "No output" checkbox is deactivated</b> (otherwise the terminal will not be visible). You must <b>also add the display variable</b> for all this to work. And, finally, you need to pass this on to gnome-terminal. Yeah, this is messy, but it's the only way I could make it work (should be easier in gnome-schedule >2.1). So, the command you should add in gnome-schedule is: <code>export DISPLAY=:0 && gnome-terminal -x knock-clock</code></li>
13
13
</ol>
 
14
 
 
15
<p>Knock Clock is Free and Open Source software by Jean-François Fortin Tam, distributed under the GNU GPL v3 license.</p>
 
 
b'\\ No newline at end of file'