myadm

commit 3a1ec0c2631b95b64daea094f896ef3bac65850c
parent 3dec5b9773f2c08e8578405efde2ac139781e2ab
Author: Claudio Alessi <smoppy@gmail.com>
Date:   Mon, 21 Mar 2016 13:17:08 +0100

Add a README.

Diffstat:
M
Makefile
 | 
2
+-
A
README
 | 
31
+++++++++++++++++++++++++++++++
M
config.mk
 | 
2
+-

3 files changed, 33 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-# myadm - MySQL admin
+# myadm - mysql admin
 # See LICENSE file for copyright and license details.
 
 include config.mk
diff --git a/README b/README
@@ -0,0 +1,31 @@
+myadm - mysql admin
+===================
+myadm is an simple, small, and mutt-like MySQL TUI.
+
+
+Requirements
+------------
+In order to build myadm you need the STFL and libmysqlclient header files.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (myadm is installed into the
+/usr/local namespace by default).
+
+Afterwards enter the following command to build and install myadm (if necessary
+as root):
+
+    make clean install
+
+
+Running myadm
+-------------
+Open a terminal and type the following:
+
+	myadm
+
+Configuration
+-------------
+The configuration of myadm is done by creating a custom config.h
+and (re)compiling the source code.
diff --git a/config.mk b/config.mk
@@ -1,4 +1,4 @@
-# myadm - MySQL admin
+# myadm - mysql admin
 VERSION = 0.1
 
 # Customize below to fit your system