From e69b2802d191d6df6beb0a2a59fce435c41ed14a Mon Sep 17 00:00:00 2001 From: Taylor Holberton Date: Sat, 1 Oct 2016 14:50:41 -0400 Subject: added new README --- README | 9 --------- README.md | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+), 9 deletions(-) delete mode 100644 README create mode 100644 README.md 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 +``` + -- cgit v1.2.3