Browse Source

Add instructions and better description to README

Starbeamrainbowlabs 1 year ago
parent
commit
9e3da7e005
1 changed files with 31 additions and 1 deletions
  1. 31
    1
      README.md

+ 31
- 1
README.md View File

@@ -1,3 +1,33 @@
1 1
 # AudioMorseDecoder
2
+> Dot dot hash!
3
+
4
+A C# program that uses NAudio to analyze an audio file and decode the detected morse signal. Currently not particularly tolerant of noise.
5
+
6
+Features:
7
+
8
+ - A two-tiered buffer system to reduce memory usage when reading long files
9
+ - A multi-step tokeniser
10
+ 	 - Extracts context-free tokens from the rolling buffer first
11
+ 	 - Converts context-free tokens into contextual tokens second
12
+ - Noise gate to extract first-level tokens
13
+ - AI-like logic to identify the speed of the morse code detected
14
+
15
+## Getting Started
16
+
17
+### Compiling
18
+Open the solution in Visual Studio / MonoDevelop / Xamarin and hit build. Alternatively, linux users can run `nuget restore && msbuild` in the root of this repository.
19
+
20
+### Usage
21
+Use the program like this:
22
+
23
+```bash
24
+./MorseDecoder.exe "/path/to/audio/file.wav"
25
+```
26
+
27
+In theory, it should support multiple audio file formats as it uses an NAudio `AudioFileReader` to read the samples from the source file.
28
+
29
+The output will show the detected morse code, and the deciphered text.
30
+
31
+## License
32
+This program is licensed under the [Mozilla Public License 2.0](https://git.starbeamrainbowlabs.com/sbrl/AudioMorseDecoder/src/master/LICENSE).
2 33
 
3
-A C# program that uses NAudio to analyze an audio file and decode the detected morse signal. Currently not particularly tolerant of noise.

Loading…
Cancel
Save