From b8c9d55126cbcdbc6ba7c749e42093cfa8b14564 Mon Sep 17 00:00:00 2001
From: Prateek Machiraju <prateek.machiraju@gmail.com>
Date: Fri, 28 Jun 2019 12:08:18 -0400
Subject: [PATCH] Create README.md

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70f8830
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# FalconLibraryC++
+
+This project is a C++ version of the more-popular Kotlin JVM library -- [FalconLibrary](https://github.com/5190GreenHopeRobotics/FalconLibrary/).
+
+Features of FalconLibraryC++ that are similar to FalconLibraryJVM:
+ * 2d geometry
+ * Arc-length parameterization of splines using recursive subdivision of arcs (from team 254)
+ * Trajectory generation with constraints on velocity and acceleration
+ 
+Features of FalconLibraryC++ that are superior to FalconLibraryJVM:
+ * Use of templates for more powerful generic library code
+ * Use of compile-time unit safety (no runtime penalty)
+ 
+Features yet to be added to FalconLibraryC++ that FalconLibraryJVM has:
+ * DifferentialDrive model
+ * 3d
+ * WPILib and FRC specific wrappers
+ * Unit models
+