Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 141 lines (86 sloc) 5.342 kb
0235ccc @carlosbrando Bump version.
authored
1 = THE AUTOTEST NOTIFICATION GEM
2
3 * http://github.com/carlosbrando/autotest-notification/
4
5
6 == DESCRIPTION:
7
8 This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results.
9
10
11 == REQUIREMENTS:
12
13 * If you're using a Mac:
14 You need to have Growl and growlnotify installed on your machine.
15
16 Download the Growl [http://growl.info/index.php] and install it like any other application on your Mac
17
18 Then you must install the growlnotify.
19
20 In your shell, cd to the directory on the Growl disk image containing growlnotify, and type ./install.sh.
21 That script will install growlnotify to /usr/local/bin and the manpage to /usr/local/man.
22
23 If you want to be notified with voice of the test results, when running an-install, pass a "-s" switch, when you do not want voices notifications anymore, just run it again without the "-s" switch.
24
25
26 * If you're using Windows (with cygwin):
27 You need to have Snarl and sncmd installed on your machine.
28
29 Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
30
31 Then download sncmd [http://www.k23productions.com/download.php?view.105] open the zip file and place
32 the executable from the zip in any directory in windows PATH (for example c:\windows).
33
34
35 * If you're using Windows (without cygwin):
36 You need to have Snarl, diffutils and ruby-snarl installed on your machine.
37
38 Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
39
40 Download DiffUtils for Windows [http://gnuwin32.sourceforge.net/packages/diffutils.htm] and follow the installation instructions on the site.
41
42 Run in the command prompt:
43
44 $ gem install ruby-snarl
45
46 After all that. You must update the environment variable PATH with the path to the bin of diffutils.
47 It's the price that was paid for using Windows (try cygwin).
48
49
50 * If you're using Linux:
51 You need to have libnotify binaries installed.
52
53 For ubuntu this means: sudo apt-get install libnotify-bin
54
55 Other distributions may package it with other names, do a search for libnotify using your distribution package manager.
56
57 If you use KDE and do not have libnotify-bin installed, it will try to use kdialog wich is part of KDE.
58 It also works if you have zenity installed.
59
60 If you want to be notified with voice of the test results, instal espeak [http://espeak.sourceforge.net/] too, it is not needed.
61 And when running an-install, pass a "-s" switch, when you do not want voices notifications anymore, just run it again without the "-s" switch.
62
63 To hear the sounds of Doom Edition, you need the mplayer [http://www.mplayerhq.hu/design7/dload.html] installed.
64
19baa44 @argent-smith Documentation: done
argent-smith authored
65 * If you are using FreeBSD:
66 Follow the instructions under 'Linux' section except
c82ff04 @argent-smith README fixed
argent-smith authored
67 package-manager-specific stuff. On FreeBSD you should use your favorite
68 package manager (options are 'portinstall', 'pkg_install' or 'make' in the
69 corresponding port's directory).
19baa44 @argent-smith Documentation: done
argent-smith authored
70
0235ccc @carlosbrando Bump version.
authored
71
72 == INSTALL:
73
74 $ sudo gem install autotest-notification
75
76 Run it to let the notifier in automatic mode:
77
78 $ an-install
79
80 In Windows without cygwin, it's necessary to install in the directory of the project:
81
82 $ an-install --path=C:\projects\my_project
83
84 To turn off the notifier:
85
86 $ an-uninstall
87
88
89 == Special Doom Edition
90
91 $ an-install --doom --speaking
92
93 == Buuf Edition - Display Buuf icons by Mattahan [http://mattahan.deviantart.com]
94
95 $ an-install --buuf
96
97 == Showing a yellow warning image when there are no errors/failures but there are pending specs
98
99 $ an-install --pending
100
101 == CONTRIBUTORS:
102
103 * carlosbrando [http://www.nomedojogo.com]
104 * simpsomboy [http://alexandredasilva.wordpress.com]
105 * urubatan [http://www.urubatan.info]
106 * chjunior [http://tas.milk-it.net]
107 * daviscabral [http://blog.impactmedia.com.br]
108 * tapajos [http://www.improveit.com.br/tapajos]
109 * tchandy [http://tchandy.wordpress.com]
110 * ozsantana [http://blog.iconcreative.net]
111 * lucasuyezu [http://xucros.com]
112 * samflores [http://www.thoughtsoverflow.com]
113 * dcrec1 [http://www.mouseoverstudio.com/blog]
114 * nuxlli [http://www.nuxlli.com.br]
115 * ernestonakamura [http://github.com/ernestonakamura]
116
117 == LICENSE:
118
119 (The MIT License)
120
121 Copyright (c) 2008
122
123 Permission is hereby granted, free of charge, to any person obtaining
124 a copy of this software and associated documentation files (the
125 'Software'), to deal in the Software without restriction, including
126 without limitation the rights to use, copy, modify, merge, publish,
127 distribute, sublicense, and/or sell copies of the Software, and to
128 permit persons to whom the Software is furnished to do so, subject to
129 the following conditions:
130
131 The above copyright notice and this permission notice shall be
132 included in all copies or substantial portions of the Software.
133
134 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
135 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
136 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
137 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
138 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
139 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
140 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.