#lang racket/base
;; For legal info, see file "info.rkt".

(require (planet neil/mcfly))

(doc (section "Introduction")

     (para (italic "This is an alpha-quality release.  Not for general use yet."))

     (para (italic "Privacy/Security Warning: McFly Tools makes frequent
requests to the PLaneT server, and these requests might reveal to the server
the package names of Racket packages that you are working on.  So don't use
McFly Tools for trade-secret packages named "
                   (code "secret-social-media-startup-based-on-rocks")
                   " just yet.  Probably this little information leak isn't a
problem for you, but we mention it on principle.  An eventual later version of
McFly Tools will likely improve this situation."))

     (para "McFly Tools is a collection of developer tools for Racket
programmers, oriented towards supporting and encouraging the sharing of Racket
code libraries as reusable PLaneT packages.")

     (para "Some things McFly Tools does are:")


      (item "Supports the embedding of documentation directly in source files,
together with the "
            (hyperlink ""
                       (bold "mcfly"))
            " runtime package.")

      (item "Maintains PLaneT development links, based on metadata in "
            (filepath "info.rkt")
            ", information from the PLaneT server, and current activity using
McFly Tools.")

      (item "Programmatically updates the "
            (filepath "info.rkt")
            " file for a package with missing definitions.  (This uses the "
            (hyperlink ""
                       (bold "progedit"))
            " package.)")

      (item "Automates building PLaneT archive files for upload to the PLaneT server."))

     (para "Note that McFly Tools is a development tool used only by those who
choose to use it.  Packages developed using McFly depend only on the "
           (bold "mcfly")
           " runtime package."))

(doc (section "Usage")
     (para "The interface to McFly Tools is the "
           (code "raco mcfly")
           " command.")

     (para "Someday this will be documented."))

(doc (section "Known Issues")

     "McFly Tools is not yet feature-complete, nor fully tested.")

(doc history

     (#:planet 1:1 #:date "2012-06-11"

                (item (code "raco mcfly planet-archive")
                      " now sets "
                      (racket force-package-building?)
                      " to "
                      (racket #f)
                      " rather than "
                      (racket #t)
                      ".  (Thanks to Robby Findler and Eli Barzilay.)")))

     (#:planet 1:0 #:date "2012-06-11"

                (item "Initial alpha-quality release.  Not for general use."))))