aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTaylor Holberton <taylorcholberton@gmail.com>2016-10-01 14:50:41 -0400
committerTaylor Holberton <taylorcholberton@gmail.com>2016-10-01 14:50:41 -0400
commite69b2802d191d6df6beb0a2a59fce435c41ed14a (patch)
tree416c314af0998fdaeb8d4193439dd4e5367ae78f
parenteee6289d13f2a58677001cda41723faa2adcb50f (diff)
added new README
-rw-r--r--README9
-rw-r--r--README.md24
2 files changed, 24 insertions, 9 deletions
diff --git a/README b/README
deleted file mode 100644
index 85b1e5e..0000000
--- a/README
+++ /dev/null
@@ -1,9 +0,0 @@
-tinyalsa: a small library to interface with ALSA in the Linux kernel
-
-The aims are:
-
-- Provide a basic pcm and mixer API
-- If it's not absolutely needed, don't add it to the API
-- Avoid supporting complex and unnecessary operations that could be
- dealt with at a higher level
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2be7d0a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+TinyALSA
+========
+
+TinyALSA is a small library to interface with ALSA in the Linux kernel.
+
+The aims are:
+
+ - Provide a basic pcm and mixer API.
+ - If it's not absolutely needed, don't add it to the API.
+ - Avoid supporting complex and unnecessary operations, that could be
+ dealt with at a higher level.
+ - Provide comprehensive documentation.
+
+### Building
+
+TinyALSA uses Makefile as the primary build system.
+
+To build and install with Make, run the commands:
+
+```
+make
+sudo make install
+```
+