README.md

   1 # AMBroS
   2
   3 ## Introduction
   4
   5 *AMBroS = Autonomous Morse code Broadcasting System*
   6
   7 Is Morse-Code on the way to die? It migh be, if not used anymore...
   8 To increase the amount of Morse code transmissions available to
   9 listeners, broadcast stations are needed that process interesting
  10 texts and transmit them for human ears: Morse-Code Broadcasting!
  11
  12 Although the running costs of a transmitting station (excluding mortgages
  13 and appreciation of equipment) consist only of the comparatively small
  14 expenses for electricity needed to actually transmit and control the
  15 transmitter, creation and assembling of transmission texts are quite
  16 expensive tasks, if done manually. Therefore, it is important to make this
  17 a process as automatic as possible, and AMBroS is meant to fill this gap.
  18
  19 AMBROS shall be a completely autonomous system, collecting textual data
  20 from different sources (online or offline), filtering them according
  21 to predefined rules, assembling the resulting texts into a contiuous
  22 transmission schedule, and broadcasting them via an attached transmitter
  23 system.
  24
  25 On the hardware side, only a low-cost computer and a suitable transmitter
  26 are needed. Depending on the chosen transmitter type, additional software
  27 drivers may be needed, to complement the core of AMBroS.
  28
  29 ## Roadmap
  30
  31 Initially, a demonstrator system shall be created, which is an assemblage
  32 of various scripts (shell, sed, awk, etc) capable of running at least
  33 a low-traffic AMBroS. This initial demonstrator may simulate the Morse
  34 code transmission, not yet relying on a real transmission system.
  35
  36 Once the demonstrator is running, its components may be gradually replaced
  37 by faster interpreted scripts or even compiled programs, while keeping the
  38 interfaces of the various components unmodified if possible. In addition,
  39 a demonstrator controlling a real transmitter shall be tested, be it on
  40 commonly available (free) frequencies, amateur radio, or any other radio
  41 service.
  42
  43 ---
  44
  45 ## Information for Developers
  46
  47 ### Git Repository Structure
  48
  49 #### Scratch
  50
  51 In `Scratch/`, contributors may create personal files with names
  52 starting with their user/account name, to store notes and other
  53 personal and project related information.
  54 Please do not tamper with other people's files!
  55
  56 #### examples
  57
  58 `examples/` contains sample or test configuration files
  59
  60 #### src
  61
  62 `src/` contains scripts or (in a later stage) sources for compilation
  63
  64 ##### morse
  65
  66 `src/morse/` contains scripts or sources concerning Morse code generation
  67
  68
  69 ---
  70
  71 _2014-July, Yargo Bonetti_ ( `HB9KNS` )