Rename init helper, and add some stuff to the readme

README.md

@@ -1 +1,15 @@
-git clone --recurse-submodules https://github.com/sz3/libcimbar.git
+## libcimbar
+### 100 kb/s over the air gap
+
+## Libraries
+Except for opencv, all of these are included in the repo. Most are header-only.
+
+* opencv - https://opencv.org/
+* base - https://github.com/r-lyeh-archived/base
+* cxxopts - https://github.com/jarro2783/cxxopts (used for command line tools)
+* fmt - https://github.com/fmtlib/fmt
+* intx - https://github.com/chfast/intx
+* libcorrect - https://github.com/quiet/libcorrect
+* libpopcnt - https://github.com/kimwalisch/libpopcnt
+* PicoSHA2 - https://github.com/okdshin/PicoSHA2 (used for testing)
+* wirehair - https://github.com/catid/wirehair

src/lib/fountain/CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.10)
 set(SOURCES
 	FountainDecoder.h
 	FountainEncoder.h
-	WirehairInit.h
+	FountainInit.h
 )
 
 add_custom_target(fountain SOURCES ${SOURCES})

src/lib/fountain/FountainDecoder.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "WirehairInit.h"
+#include "FountainInit.h"
 #include "wirehair/wirehair.h"
 #include <array>
 #include <optional>
@@ -15,7 +15,7 @@ class FountainDecoder
 public:
 	static bool init()
 	{
-		return WireHairInit::init();
+		return FountainInit::init();
 	}
 
 public:

src/lib/fountain/FountainEncoder.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "WirehairInit.h"
+#include "FountainInit.h"
 #include "wirehair/wirehair.h"
 #include <array>
 #include <vector>
@@ -15,7 +15,7 @@ public:
 	using buffer = std::array<uint8_t,_packetSize>;
 	static bool init()
 	{
-		return WireHairInit::init();
+		return FountainInit::init();
 	}
 
 public:

src/lib/fountain/FountainInit.h

@@ -2,7 +2,7 @@
 
 #include "wirehair/wirehair.h"
 
-namespace WireHairInit {
+namespace FountainInit {
 	static bool init()
 	{
 		static WirehairResult res = wirehair_init();