Add a quickstart instruction list

2 files changed, 54 insertions, 0 deletions

diff --git a/QUICKSTART b/QUICKSTART
new file mode 100644
index 0000000..a66b94e
--- /dev/null
+++ b/QUICKSTART
@@ -0,0 +1,50 @@
+Some typical uses:
+
+A.	Capturing a POST trace
+B.	IO logging a mode set
+
+A. Capturing a POST trace
+=========================
+
+0.	Be prepared for the possibility of crashing
+
+1.	Change to VT. Doing this in X is going to go bad
+
+2.	Run 'make' in the vbtracetool directory, if you haven't already
+
+3.	Run "./postandrestore.bash -d 2> logfile"
+
+	Note that logfile will be big (300MB-3GB), and note the '2' in
+	the redirection "2> logfile".
+	This step will take a little while (~30s) and during this time
+	your screen may do various odd looking things. Do not attempt to make
+	the machine do anything else during this time (with the exception of
+	resetting, if it gets stuck -- HD activity being a good indicator)
+
+3b.	If you make it back to the message "POST complete", a visible prompt,
+	and a reasonably large logfile, proceed to step 4, otherwise complain to
+	whoever told you to do this in the first place
+
+4.	Run "./deloopify logfile". Another file "logfile-deloopd", somewhat
+	smaller than the original log, will be produced
+
+5.	"gzip -9 logfile-deloopd"
+
+6.	Introduce "logfile-deloopd.gz" to whoever wants it
+
+B. IO logging a mode set
+========================
+
+1.	Change to VT. Doing this in X is going to go bad
+
+2.	Run 'make' in the vbtracetool directory, if you haven't already
+
+3.	Run "./vbtracetool" and note the returned mode number (in parentheses)
+
+4.	Run "./vbtracetool -ls YOURMODENUMBER 2> logfile"
+
+	Logging should be near instant, and the logfile should run to a few MB.
+	As for use case A, note the '2' in the redirection "2> logfile"
+
+5.	Compress logfile with your favourite utility, and acquaint the person
+	requesting the log with it
diff --git a/README b/README
index 5d84783..a3098d5 100644
--- a/README
+++ b/README
@@ -1,3 +1,7 @@
+
+this README lists and explains the possibilities of the vbtracetool tools
+the file QUICKSTART may provide a more concise and direct route to your ends
+
 vbtracetool
 ===========