[Rubydoc-devel-cvs] CVS: rubydoc LICENSE,NONE,1.1 Makefile,NONE,1.1 README,NONE,1.1 VISION,NONE,1.1

[Sean C. <the...@us...>]

Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv12491

Added Files:
	LICENSE Makefile README VISION 
Log Message:
Initial checkin for the rubydoc project.

Functioning rubydoc included


--- NEW FILE: LICENSE ---
# $Id: LICENSE,v 1.1 2001/08/29 19:03:33 thetitan Exp $
All of the documentation and software included in rubydoc releases is
copyrighted by Sean Chittenden <se...@ch...>

Copyright 2001
	Sean Chittenden <se...@ch...>.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
   must display the following acknowledgment:

    This product includes software developed by Sean Chittenden
    <se...@ch...> and rubydoc's contributors.

4. Neither the name of the software nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.


If you have any questions regarding the redistribution of this software,
please contact the author at <se...@ch...>.
--- NEW FILE: Makefile ---
# $Id: Makefile,v 1.1 2001/08/29 19:03:33 thetitan Exp $

install:
	install -c -m 555 -o 0 -g 0 src/rubydoc /usr/local/bin/rubydoc

uninstall:
	rm -f /usr/local/bin/rubydoc

--- NEW FILE: README ---
To install:

	install rd2 (part of ruby-rdtool package)

	make install

--- NEW FILE: VISION ---
In a nutshell, this is what I want rubydoc to be:

1) A command line tool that allows for easy access to ruby
   documentation.

2) An online initiative aimed at collecting user feedback,
   experiences, and stories with ruby classes and modules (hosted on
   rubydoc.org).

3) A compolation tool used to dump the collected from the online forum
   into a distributable medium so that comments are available from the
   CLI (data probably stored in rd or XML).

4) A CLI that will let you, if you have a net connection, browse the
   online rubydoc comments (probably SOAP).

5) rubydoc is a cross between perldoc and the PHP documentation at
   php.net.

6) rubydoc is set to evolve with the language and be defined through
   its user community.

7) rubydoc will use the reflection API to make all methods available
   for comment and user review.

8) The online forum will have user accounts and watches to allow
   people to track comments and/or official documentation changes.

If you have any questions/comments, please send them to:
<rub...@li...>

To subscribe to the mailing list:
http://lists.sourceforge.net/lists/listinfo/rubydoc-devel