summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d69647c
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+Build instrcutions
+------------------
+
+Building xed should be fairly easy on most systems with a semblence of POSIX
+compliance as it doesn't use anything too flash.
+
+You should find in this archive :
+
+ Makefile - makefile
+ xed.c - The source
+ xedkeys.h - The keys used. Stored here for easier personalisation.
+ xed.1 - man page
+ xed.txt - ASCII version of man page
+ README - This file
+
+
+To build:
+
+ make
+
+Then copy xed to a directory on your PATH for ease of use. man.1 can be
+installed in /usr/local/man/man1 or your system's equivalent.
+
+If the make fails, read Makefile for configuration info regarding
+curses/ncurses.