From 8eb0f2010aeccc055a7c4ec895bfd912ce53508e Mon Sep 17 00:00:00 2001
From: Erik Strand <erik@erikstrand.net>
Date: Wed, 8 May 2019 22:56:08 -0400
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..751688b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Compressed Sensing
+
+I used this code to solve problem 15.7 of Neil's Physics of Information
+Technology, as taught spring 2019. For now you can access the class page
+[here](http://fab.cba.mit.edu/classes/862.19/), and my solutions for this
+particular problem set
+[here](http://fab.cba.mit.edu/classes/862.19/people/erik/psets/12.html), though
+these links may
+change in the future and I don't promise to keep this up to date.
+
+## Dependencies
+
+The C++ code is built with cmake, and uses Eigen. It prints numpy arrays to
+stdout that you can paste into `plotter.py` (sorry). The plotting code uses
+numpy and matplotlib. I use Python 3 but it would probably work with Python 2 as
+well.
+
+## Building
+
+First clone the repo, or download and extract all files. Then from the project's
+root directory, run
+
+```
+mkdir build
+cd build
+cmake ..
+make
+```
+
+An executable `compressed_sensing` will be generated in the `build` directory.
\ No newline at end of file
-- 
GitLab