Squashed commit uhd/cleanup.

1 files changed, 71 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..8d78c4f10
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+USRP Hardware Driver (UHD™) Software
+========================================
+
+Welcome to the UHD™ software distribution! UHD is the free & open-source
+software driver and API for the Universal Software Radio Peripheral (USRP™) SDR
+platform, created and sold by Ettus Research, LLC.
+
+UHD supports all Ettus Research USRP™ hardware, including all motherboards and
+daughterboards, and the combinations thereof.
+
+## Documentation
+
+The [UHD Homepage](http://code.ettus.com/redmine/ettus/projects/uhd/wiki),
+through which you can find installation instructions, documentation, and further
+information, is the primary source of UHD documentation and "Getting
+Started"-type guides.
+
+For technical documentation related to USRP™ hardware or UHD system
+design, check out the [UHD Manual](http://files.ettus.com/uhd_docs/manual/html/).
+
+If you are looking for API documentation, check out the following resources:
+
+* [Doxygen](http://files.ettus.com/uhd_docs/doxygen/html/index.html)
+* [Coding to the API](http://files.ettus.com/uhd_docs/manual/html/coding.html)
+* [Device Streaming](http://files.ettus.com/uhd_docs/manual/html/stream.html)
+
+Additionally, be sure to check out the Ettus Research
+[FAQ](http://www.ettus.com/kb/detail/frequently-asked-questions), and the
+[Knowledge Base](http://www.ettus.com/kb) for useful application notes and
+tutorials.
+
+## OS Support
+
+UHD is primarily developed on Linux, but we also test and support the following
+operating systems.
+
+* Linux (any distribution)
+* Mac OSX (PPC and Intel)
+* Windows 7/Vista/XP/2000
+
+## Applications
+
+UHD can be used to build stand-alone applications with USRP™ hardware, or with
+third-party applications. Some common toolkits / frameworks are:
+
+* [GNURadio](http://code.ettus.com/redmine/ettus/projects/uhd/wiki/GNU_Radio_UHD)
+* [LabVIEW](http://joule.ni.com/nidu/cds/view/p/id/2679/lang/en)
+* [Simulink](http://www.mathworks.com/discovery/sdr/usrp.html)
+* [OpenBTS](http://wush.net/trac/rangepublic/wiki/BuildInstallRun)
+* [Iris](http://www.softwareradiosystems.com/redmine/projects/iris/wiki)
+* [Redhawk](https://github.com/redhawksdr)
+* [Amarisoft LTE eNodeB](http://www.amarisoft.com/?p=amarilte)
+
+## Directories
+
+__host/__
+
+The source code for the user-space driver.
+
+__firmware/__
+
+The source code for all microprocessors in USRP hardware.
+
+__fpga/__
+
+The source code for the UHD FPGA images.
+
+__images/__
+
+This contains the package builder for FPGA and firmware images.
+