Let me apologize if attaching files to emails on this list is inappropriate.
The last few months, part of my job has been to document the building,
configuring, maintenance of Windows 2003 servers - the documentation
that I had to write was almost step-by-step. It was intended for
people somewhat familiar with the Windows environment.
My intended audience for the MythTV user manual is the same audience -
people familiar with Windows. I assume these people can use web
browsers and CD writers etc. But I do not assume that they are
familiar with bash commands etc.
The document that I have attached is obviously only a sample of the
writing style for the document. I used XMLMind to create the DocBook
XML file. This way the look & feel can be changed for various purposes
(web, print outs, etc).
There is a ton of documentation on mythtv.info that I want to re-use
in this document. I believe that the documentation already available
on mythtv.org and mythtv.info is fairly comprehensive - but the
problem is that it tries to cover all situations/setups. I think we
are missing out on the audience that thinks "I just want a PVR. Tell
me how to make it! I'll find the parts you tell me to get, and install
the OS that you want me to install... "
Please send me comments/feedback. If someone can give me a reason why
such a document should not exist, please do not hesitate to let me
know. I'm not trying to make busy-work for myself - I just want to
give back to the community for such a great product.
If I have no objections, I will start to document the Debian
installation instructions in fairly great detail. I will have a box
beside me, and document the step-by-step installation.
Thanks in advance
--
Nav
On Thu, 17 Feb 2005 17:17:58 -0500, Jay R. Ashworth <[EMAIL PROTECTED]> wrote:
> On Thu, Feb 17, 2005 at 12:14:00PM -0800, Nav Jagpal wrote:
> > However, I would like to start with user documentation. I'm sure there
> > is someone out there that would like to join the development process,
> > and what is a better way then documenting what is currently there.
>
> You bet.
>
> http://www.mythtv.info/moin.cgi/UserManual
>
> Cheers,
> -- jr 'we're moving it soon, but don't let that stop you' a
> --
> Jay R. Ashworth [EMAIL
> PROTECTED]
> Designer Baylink RFC 2100
> Ashworth & Associates The Things I Think '87 e24
> St Petersburg FL USA http://baylink.pitas.com +1 727 647 1274
>
> If you can read this... thank a system adminstrator. Or two. --me
>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";>
<book>
<title>MythTV User Manual</title>
<chapter>
<title>Building Base Machine</title>
<section>
<title>Introduction</title>
<para>This section describes, in detail, the procedures involved with
building a machine for use with MythTV. </para>
</section>
<section>
<title>Requirements</title>
<para>This section describes the hardware and software requirements for
building a base machine.</para>
<section>
<title>Minimum Hardware Requirements</title>
<para>The following hardware items can be purchased or found around
the house and assembled into a single unit. Remember that these are
minimum hardware requirements - faster CPU, more memory, and more disk
space the better.</para>
<para><itemizedlist>
<listitem>
<para>Intel P4 2.4 GHz or AMD 1800+</para>
</listitem>
<listitem>
<para>512 MB RAM</para>
</listitem>
<listitem>
<para>80 GB hard drive</para>
</listitem>
<listitem>
<para>PCI Sound Card</para>
</listitem>
<listitem>
<para>Onboard Video or standard video card</para>
</listitem>
<listitem>
<para>PC to TV Video Converter</para>
<para><emphasis>Example</emphasis>: Kworld PC to TV Converter
(http://www.tigerdirect.com/applications/SearchTools/item-details.asp?EdpNo=557804&CatId=1430)</para>
</listitem>
<listitem>
<para>Onboard Ethernet or standard ethernet card</para>
</listitem>
</itemizedlist>At the time of this writing, a machine with the above
parts would cost about $500 CDN (http://www.ncix.com)</para>
</section>
<section>
<title>Software Requirements</title>
<para>This section describes the core software that is to be installed
and configured. Full procedures for obtaining, installing, and
configuring the various pieces of software, will be covered in the
upcoming sections.</para>
<para><itemizedlist>
<listitem>
<para>Debian - Operating System - http://www.debian.org</para>
<para>Debian is a free and open source operating system.</para>
</listitem>
<listitem>
<para>MythTV - PVR Application - http://www.mythtv.org</para>
</listitem>
</itemizedlist></para>
</section>
</section>
<section>
<title>Installing and Configuring the Operating System</title>
<para>This section describes the procedures involved in configuring and
installing the operating system. </para>
<section>
<title>Obtaining Debian</title>
<para><orderedlist>
<listitem>
<para>Launch a web browser and navigate to
http://www.debian.org/devel/debian-installer/</para>
</listitem>
<listitem>
<para>Under "netinst CD image, with Debian base", click on
"i386".</para>
</listitem>
<listitem>
<para>Save the ISO file to your hard drive, and make note of the
location. Wait while the download finishes.</para>
</listitem>
<listitem>
<para>Once the download is complete, burn the ISO image to CD
using CD-Writing software such as Nero
(http://www.nero.com).</para>
</listitem>
</orderedlist></para>
</section>
<section>
<title>Installing Debian</title>
<para>Now that you have a Debian installation CD, you are now ready to
begin with the operating system installation.</para>
<para><orderedlist>
<listitem>
<para>Boot the computer using the Debian CD</para>
</listitem>
<listitem>
<para></para>
</listitem>
</orderedlist></para>
</section>
</section>
</chapter>
</book>_______________________________________________
mythtv-dev mailing list
[email protected]
http://mythtv.org/cgi-bin/mailman/listinfo/mythtv-dev
