README.md

   1 # AMBROS
   2
   3 *A*utonomous *M*orse code *BRO*adcasting *S*ystem
   4
   5 Is Morse-Code on the way to die? It migh be, if not used anymore...
   6 To increase the amount of Morse code transmissions available to
   7 listeners, broadcast stations are needed that process interesting
   8 texts and transmit them for human ears: Morse-Code Broadcasting!
   9
  10 In the end, AMBROS shall be a completely automatic and autonomous
  11 system, collecting textual data from different sources (online or
  12 offline), filtering them according to predefined rules, assembling
  13 the resulting texts into a contiuous transmission schedule, and
  14 broadcasting them via an attached transmitter system.
  15
  16 On the hardware side, a low-cost computer and a suitable transmitter
  17 are needed. Depending on the chosen transmitter type, software
  18 drivers may be needed.
  19
  20 ---
  21
  22 ## repository structure
  23
  24 ### Scratch
  25
  26 In `scratch/`, contributors may create personal files with names
  27 starting with their user/account name, to store notes and other
  28 personal and project related information.
  29 Please do not tamper with other people's files!
  30
  31 ### examples
  32
  33 `examples/` contains sample or test configuration files
  34
  35 ### src
  36
  37 `src/` contains scripts or (in a later stage) sources for compilation
  38
  39 #### morse
  40
  41 `src/morse/` contains scripts or sources concerning Morse code generation
  42