aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2021-07-24 14:52:06 -0400
committerB. Watson <yalhcru@gmail.com>2021-07-24 14:52:06 -0400
commit940d66d839e7e5ec4b8f92704538b07c94310065 (patch)
treef9ed80f2a869b5ac47ac68e2bd8f00e1fe663338
parent293d667dd9be7f11f81fc52ee6cecab8ce682d0c (diff)
downloadslowbaud-940d66d839e7e5ec4b8f92704538b07c94310065.tar.gz
add INSTALL.txt and .gitignoreHEADmaster
-rw-r--r--.gitignore2
-rw-r--r--INSTALL.txt17
2 files changed, 19 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f5a571c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+slowbaud
+test.out
diff --git a/INSTALL.txt b/INSTALL.txt
new file mode 100644
index 0000000..804bfa5
--- /dev/null
+++ b/INSTALL.txt
@@ -0,0 +1,17 @@
+slowbaud is pretty simple to build.
+
+Prerequisites:
+
+- UNIXish OS (possibly even Windows, these days)
+- C compiler
+
+You should be able to build slowbaud with "make" (which can be either
+GNU or BSD make). It'll run from its source directory (as ./slowbaud),
+and you can install it system-wide with "make install"... which
+supports standard variables like DESTDIR for packagers.
+
+If you're going to edit the documentation, it's in RST and you'll
+need the rst2man.py (or just rst2man) command. On Slackware 14.2,
+this comes from the docutils package on SlackBuilds.org; on 15.0
+it will be in the core OS, as python-docutils. On Debian, it's in
+python3-docutils.