From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mo DeJong To: sourcenav@sources.redhat.com Subject: Helping new SN users (Re: Printing XREF from SN 5.0) Date: Tue, 29 May 2001 16:31:00 -0000 Message-id: References: <3B14207A.190F9B82@tr.comm.mot.com> X-SW-Source: 2001-q2/msg00181.html On Tue, 29 May 2001, Hugo Varotto wrote: > Hi Mo, Hi Hugo. > could you please expand a little bit what you need with respect to the README > files ? I'm not an expert writing documentation neiter an expert in Source > Navigator, but I'll try to help as much as I can. > > Hugo For one thing, we want to try to stick to existing best practices. ftp://ftp.gnu.org/pub/gnu/standards/standards.text I would think a README and INSTALL file at the very least. There is already a toplevel README but it does not help much. What we want it a README that tells people a bit about Source-Navigator, what it does, why it is useful, and where to find info about how to build and INSTALL it. The goal of these initial help files is simply to help people get started. We don't want people to give up without even trying simply because they don't know where to get started (sadly, this is a real problem). Of course, if you want to know what types of getting started questions folks are likely to ask, just go to the source. http://sources.redhat.com/ml/sourcenav/ Mo DeJong Red Hat Inc