diff --git a/READ-1ST.txt b/READ-1ST.txt new file mode 100644 index 0000000..ced0eb1 --- /dev/null +++ b/READ-1ST.txt @@ -0,0 +1,39 @@ +'twander' QUICKSTART +==================== + +Everyone seems to hate reading documentation, so this is a fast-track +to getting started with 'twander'. However, a lot of time and +skull-sweat went into writing THE DOCS and you really should take the +time to read them if you want to truly understand this program and +what it can do for you: + +- NOTE: 'twander' is a tool for experienced Power Users and + Programmers. You need to understand the command shell and scripting + on your system in order to effectively use the program. If you do + not, you will become quickly frustrated with 'twander', so spare + yourself the aggravation. + +- Unpack the distribution tarball someplace safe. + +- Installation is *manual*. The only exception is on FreeBSD where + there is (or soon will be) a port for this program. The 'Makefile' + in the distribution archive is only for the FreeBSD port and should + not be used elsewhere. THE DOCS have a nice short section on + installation on various OSs. + +- The example '.twander' configuration file has everything commented + out. If you start the program with this configuration, *you will + have no commands defined*. Several simple Command Definition + examples can be found in this file, so you can get started quickly + by uncommenting one or more of them. THE DOCS have a nice long + section on writing command definitions. + +- This is a very powerful program with a nifty little macro language. + You have to READ THE DOCS to really understand and exploit what's + going on here. + +- You would be well served to joing the 'twander-users' mailing list + as documented in THE DOCS. + + +