bst[lc] manual V0.03
BradC
Posts: 2,601
So, I've done a bit more work and I think it's at a stage that people might find useful.
It glosses over all bstc command line options, what the optimisations are and how they work, some of the lesser-known bst features and a few bits & bobs.
I'll continue to work on it as people ask questions, I add features and I generally get time to add more information, but what is there I think is generally useful.
Now, I've written plenty of documentation in my time, but I've never written a manual. Heck, I hardly read the damn things, how would I know what goes in 'em.
I'm hoping that by writing a manual for bst and friends, I can spend less time answering questions (the answers to which are buried in a 50 page thread) and more time actually working on it. Soooooo.. I've bitten the bullet and decided to get cracking.
My problem is, I don't actually know what I'm doing, so I've put about two hours into it and thrown some mud at the wall. The stuff that has stuck (sparse as it is) is in the 15 page pdf attached to this post. I'm throwing myself wide open and soliciting honest feedback on everything (I *really* don't know what I'm doing).
What's there is there. I tried to throw in enough snippets to get a good idea of what the overall style may be. Content is sparse however.
As before public feedback is fine. brad[noparse][[/noparse]at]proptools.org if you want to be more discrete.
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
You only ever need two tools in life. If it moves and it shouldn't use Duct Tape. If it does not move and it should use WD40.
Post Edited (BradC) : 4/23/2010 5:13:17 AM GMT
It glosses over all bstc command line options, what the optimisations are and how they work, some of the lesser-known bst features and a few bits & bobs.
I'll continue to work on it as people ask questions, I add features and I generally get time to add more information, but what is there I think is generally useful.
Now, I've written plenty of documentation in my time, but I've never written a manual. Heck, I hardly read the damn things, how would I know what goes in 'em.
I'm hoping that by writing a manual for bst and friends, I can spend less time answering questions (the answers to which are buried in a 50 page thread) and more time actually working on it. Soooooo.. I've bitten the bullet and decided to get cracking.
My problem is, I don't actually know what I'm doing, so I've put about two hours into it and thrown some mud at the wall. The stuff that has stuck (sparse as it is) is in the 15 page pdf attached to this post. I'm throwing myself wide open and soliciting honest feedback on everything (I *really* don't know what I'm doing).
What's there is there. I tried to throw in enough snippets to get a good idea of what the overall style may be. Content is sparse however.
As before public feedback is fine. brad[noparse][[/noparse]at]proptools.org if you want to be more discrete.
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
You only ever need two tools in life. If it moves and it shouldn't use Duct Tape. If it does not move and it should use WD40.
Post Edited (BradC) : 4/23/2010 5:13:17 AM GMT
pdf
688K
Comments
I'd suggest getting rid of the black background - printing that info drains toner very fast. You could show code examples in a variety of different way - how does the WAM book show code?
Keep going - good work!
Watch the date format, you know what those yanks are like, they are more stuck with tradition than the "old country"
You have been doing a lot of good work and yet you are not even stopping at documenting it well either! Name your poison and I'll be glad to send you some as a gesture of appreciation.
Cheers
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
*Peter*
If I had any talent for documentation I would start
on a PASM tutorial/book of some kind.
But it would need a lot of editing...lol
bst rocks, I have been playing with it along with PropBasic.
I did some test prints on a B/W printer to ensure legibility.
Rev2
I'm not taking hostages on the date format though [noparse];)[/noparse]
This is being written with OpenOffice. I started exploring LyX, but I just could not seem to get the control I wanted over the shell and program listing panes without going to Guru level LaTeX understanding. OpenOffice has some quirks I don't like, but I still like it a whole lot better than the alternative.
@holly, I don't have a talent for writing either, but I figure any way you get it down might help someone, somewhere.
Jon Williams has a talent for writing. His manuals are something to aspire to!
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
You only ever need two tools in life. If it moves and it shouldn't use Duct Tape. If it does not move and it should use WD40.
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
You only ever need two tools in life. If it moves and it shouldn't use Duct Tape. If it does not move and it should use WD40.