diff options
| author | schmidt <douglascraigschmidt@users.noreply.github.com> | 1998-08-26 01:44:12 +0000 |
|---|---|---|
| committer | schmidt <douglascraigschmidt@users.noreply.github.com> | 1998-08-26 01:44:12 +0000 |
| commit | eea0021983aea847af979abcd1fd0b0376d89af4 (patch) | |
| tree | 7ec316aa14543dffaf1b713f9f851b9ab138b60c /etc | |
| parent | c2d44f8500ad2064fafe2188e3aefde62bc15652 (diff) | |
| download | ATCD-eea0021983aea847af979abcd1fd0b0376d89af4.tar.gz | |
*** empty log message ***
Diffstat (limited to 'etc')
| -rw-r--r-- | etc/ACE-tutorials-intro.html | 72 | ||||
| -rw-r--r-- | etc/ACE-tutorials-overview.html | 50 |
2 files changed, 122 insertions, 0 deletions
diff --git a/etc/ACE-tutorials-intro.html b/etc/ACE-tutorials-intro.html new file mode 100644 index 00000000000..f8685bea71a --- /dev/null +++ b/etc/ACE-tutorials-intro.html @@ -0,0 +1,72 @@ +<TITLE>ACE Beginners' Guide</TITLE> +<BODY text = "#000000" link="#000fff" vlink="#ff0f0f" bgcolor="#ffffff"> + +<CENTER><H1>The Beginners' Guide to ACE</H1></CENTER> +<P> + +This site is dedicated to developing a set of tutorials to get ACE +newcomers up to speed with the framework. For now, this will be +limited strictly to ACE matters but I'm not opposed to setting up a +separate area for TAO. In fact, I encourage it! <P> + +Here are some general guidelines for creating tutorials: +<P> +<UL> +<LI> Choose a topic that you know very well or are just learning. +<P> + This isn't really a conflict... +<P> + If you know a topic very well, you're likely to know what is most + important to the novice and what can be left until later. If you're + just learning a topic, then you know what questions you have that + must be answered before you can continue. +<P> +<LI> Keep it simple. +<P> + Don't try to use a lot of really cool ACE features along the way. Stick + to the basic stuff and show that. Try to use a minimum of ACE objects + that are not the direct target of the tutorial. +<P> + (For instance, don't get all caught up in ACE_Singleton<> if you're + trying to show how to use an ACE_Reactor.) +<P> + If you want to show something really cool that happens to depend on + another ACE feature, do a tutorial on that other feature first! I've + found that folks will tend to get stuck on *anything* they don't + understand even if it isn't directly relevant to what you're trying + to teach. +<P> +<LI> Document the heck out of it! +<P> + There's no such thing as too much documentation. Don't worry about + repeating yourself along the way. Assume that the reader knows nothing + at all about the topic at hand and explain even the parts that you feel + are painfully obvious. +<P> + If you feel that sticking a bunch of comments in the code makes it harder + to read then stick in a label and document at the end of the file or + something. Alternately, create both a well-documented version and a + sparsely-documented version. Then folks can choose between 'em. +<P> +<LI> Over-teach it. +<P> + If there's a tutorial created for a topic that you feel strong in, + create another one anyway. Everybody tends to code a little differently. + Perhaps your tutorial style will "feel" better to some newcomers + than an existing tutorial. You won't hurt anybody's feelings if + you present the same material in a different way. +<P> +<LI> Steal existing code. +<P> + The ultimate form of code reuse :-) Seriously... grab one or more + of the existing ACE tests or examples. Then strip it down to the + bare bones & add heaps of comments. I don't think the software-police + will be coming after anyone for that! +</UL> +<P> +If this thing takes off, I'll start to organize the tutorials into +groups. For now, lets concentrate on quantity & quality. Organization +can come later... +<P> +<A HREF="tutorials">Follow this link to the tutorials...</A> + diff --git a/etc/ACE-tutorials-overview.html b/etc/ACE-tutorials-overview.html new file mode 100644 index 00000000000..44d21201795 --- /dev/null +++ b/etc/ACE-tutorials-overview.html @@ -0,0 +1,50 @@ +<BODY text = "#000000" link="#000fff" vlink="#ff0f0f" bgcolor="#ffffff"> + +<B>What's here?</B> +<P> + +<LI><A HREF="Examples">Examples</A> +<UL> + Very rough proof of concept apps used during my + ACE learning phase. The stuff here was used as + the stepping stone to create the initial Tutorials +</UL> + +<LI><A HREF="tutorials">Tutorials</A> +<UL> + A refinement of the Examples. There are only a + handfull of tutorials here but they should give + you an idea of the direction I was taking. +</UL> + +<LI><A HREF="Guidelines.html">Guidelines.html</A> +<UL> + A rough-draft of guidelines for creating a new set + of Tutorials more up to date and generally useful. +</UL> + +<LI><A HREF="Mail">Mail</A> +<UL> + This was to be a collection of mail messages relevant + to our development process. Since then, I've started + filing everything in my personal mailbox... + If this site begins to get a lot of traffic, I'll move + this somewhere less intrusive. (Likewise for the + <i>acemail</i> file.) +</UL> +</UL> +<P> +Except for the Guidelines, all of what you see is very out +of date. Probably on the order of a year or so. Still, +the direction and goal remain the same: create a set of +tutorials that can be used by experienced C++/OOP programmers +to learn the ACE framework. +<P> +I encourage any readers of this page to contact me if you have +suggestions or want to create a tutorial of your own. +During "normal business hours" (EST) you can get me quickest +at <A href="mailto:jcej@lads.com">jcej@lads.com</A>. +After dark & on the weekends you'll find +me at home: <A HREF="jcej@tragus.org">jcej@tragus.org</A>. +Of course, I'm always checking the ACE mailing list. +<P> |