From 85fcd83b5494fedb7770a065cefb6ef3ba24d8b7 Mon Sep 17 00:00:00 2001 From: Ken Elf Mathieu Sternberg Date: Wed, 29 Feb 2012 17:20:28 -0800 Subject: [PATCH] Updated readme. --- README.md | 67 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 39 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 9928f6e..f7d49fa 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,43 @@ - Thinksaber - Turn your laptop into a lightsaber +# Thinksaber - Turn your laptop into a lightsaber! -NO WARRANTY GRANTED OR IMPLIED +## Main Idea -Copyright (C) 2008 Elf M. Sternberg +Thinksaber uses the Hard Drive Active Protection System available on +IBM and Lenovo Thinkpad laptops to detect when the laptop is in motion +and make an appropriately giggle-worthy Star Wars-like lightsaber +sound effect. It was an attempt to teach myself some audio and PyGame +interaction. This is the result. Warning: For all I know, this is a +*really bad* thing to do to your hard drive, although I never saw any +problems during testing. See the "NO WARRANTY GRANTED OR IMPLIED" +line down below. + +## Acknowledgements + +Thinksaber is obviously inspired by the program MacSaber, and I'm +grateful to the MacSaber people for assembling the Star Wars sound +effects collection needed to make it so successful. + +Thinksaber uses a motion-detection algorithm derived from the one +written by Tatsuhiko Miyagawa (miyagawa at gmail.com) for his own +thinkpad-saber program, which ran only under Perl for Windows. +Obviously, I think mine's better. + +## Requirements + +Thinksaber runs under PyGame, a python-based gaming library, and +should run on any IBM or Lenovo Thinkpad with PyGame installed. Under +Linux, you may have to activate HDAPS and the joystick device. + +## Porting + +Thinksaber should run under Windows, but I don't have a Microsoft +Windows installation and so have no idea how to detect the +accelerometer. Tatsuhiko Miyagawa's perl version is exclusively for +MS Windows, so in theory porting it should be possible. + +## NO WARRANTY GRANTED OR IMPLIED + +Copyright (C) 2008-2012 Elf M. Sternberg Thinksaber is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the @@ -19,28 +54,4 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -ACKNOWLEDGEMENTS - -Thinksaber is obviously inspired by the program MacSaber, and I'm -grateful to the MacSaber people for assembling the Star Wars sound -effects collection needed to make it so successful. - -Thinksaber uses a motion-detection algorithm derived from the one -written by Tatsuhiko Miyagawa (miyagawa at gmail.com) for his own -thinkpad-saber program, which ran only under Perl for Windows. -Obviously, I think mine's better. - -REQUIREMENTS - -Thinksaber runs under PyGame, a python-based gaming library, and -should run on any IBM or Lenovo Thinkpad with PyGame installed. Under -Linux, you may have to activate HDAPS and the joystick device. - -PORTING - -Thinksaber should run under Windows, but I don't have a Microsoft -Windows installation and so have no idea how to detect the -accelerometer. Tatsuhiko Miyagawa's perl version is exclusively for -MS Windows, so in theory porting it should be possible. - - - Elf M. Sternberg + - Elf M. Sternberg