Changeset 119:3a24ab5a997b

Show
Ignore:
Timestamp:
11/08/08 02:47:52 (3 years ago)
Author:
cfreeze@…
Branch:
unix
Message:

add quick start information

Files:
1 added
1 modified

Legend:

Unmodified
Added
Removed
  • README

    r108 r119  
    2525expiration times of the alerts. 
    2626 
    27  
    2827StormSiren is written in the Python programming language.  It 
    2928has been developed and tested under Python version 2.5, though earlier  
     
    3130on a number of platforms, including Linux, Solaris 2.8, OS/2 Warp,  
    3231Windows 2000, and Windows 98.   
    33  
    3432 
    3533In order to run StormSiren, you'll need to have Python on your system. 
     
    3937Unix/Linux users, you may or may not need to modify the first line 
    4038shebang and/or set the file permissions properly.  RedHat users may  
    41 want to change the shebang to #!/usr/bin/env python2.  The first time 
    42 you run the program, it will walk you through setting up a  
    43 configuration file.  Once you've completed the setup, you can edit it 
    44 at any time with a text editor, or just delete or rename the config 
    45 file and StormSiren will run the configuration wizard again. 
     39want to change the shebang to #!/usr/bin/env python2. 
    4640 
     41In order to use StormSiren, you will need to create two configuration 
     42files.  Examples of these files can be found in the examples directory 
     43in the root of this directory.  Information about these files can be 
     44found by visiting the website: 
     45 
     46         http://www.cfreeze.com/trac/stormsiren/wiki/Configuration 
    4747 
    4848Once you have your configuration setup, you'll want to test it by 
     
    6262 
    6363StormSiren can send two types of messages, short text (SMS) and full text. 
    64 SMS mode sends short text messages to SMS type devices such as 
     64SMS mode sends short text messages to SMS type devices such as MythTv, 
    6565cell phones, pagers, and wireless enabled PDAs.  Full text (e-mail) mode 
    6666sends the full text of the NWS bulletin.  This allows you to get an alert