readme.html

   1 <html>
   2 <head><title>Factor</title></head>
   3
   4 <body>
   5 <h1>The Factor programming language</h1>
   6
   7 <h2>Getting started</h2>
   8
   9 <p>If you are reading this README file, you either downloaded a binary
  10 package, or checked out Factor sources from the GIT repository.</p>
  11
  12 <ul>
  13 <li><a href="http://concatenative.org/wiki/view/Factor/Getting%20started">Getting started</a></li>
  14 <li><a href="http://concatenative.org/wiki/view/Factor/Requirements">System requirements</a></li>
  15 <li><a href="http://concatenative.org/wiki/view/Factor/Building%20Factor">Building Factor from source</a> (don't do this if you're using a binary package)</li>
  16 </ul>
  17
  18 <p>To run Factor:<p>
  19
  20 <ul>
  21 <li>Windows: Double-click <code>factor.exe</code>, or run
  22 <code>.\factor.com</code> in a command prompt</li>
  23 <li>Mac OS X: Double-click <code>Factor.app</code> or run <code>open
  24 Factor.app</code> in a Terminal</li>
  25 <li>Unix: Run <code>./factor</code> in a shell</li>
  26 </ul>
  27
  28 <h2>Documentation</h2>
  29
  30 <p>The Factor environment includes extensive reference documentation and
  31 a short "cookbook" to help you get started. The best way to read the
  32 documentation is in the UI; press F1 in the UI listener to open the help
  33 browser tool. You can also <a href="http://docs.factorcode.org">browse
  34 the documentation online</a>.</p>
  35
  36 <h2>Command line usage</h2>
  37
  38 <p>Factor supports a number of command line switches. To read command line
  39 usage documentation, enter the following in the UI listener:</p>
  40
  41 <pre>"command-line" about</pre>
  42
  43 <h2>Source organization</h2>
  44
  45 The Factor source tree is organized as follows:
  46
  47 <li><code>build-support/</code> - scripts used for compiling Factor (not
  48 present in binary packages)</li>
  49 <li><code>vm/</code> - Factor VM source code (not present in binary
  50 packages)</li>
  51 <li><code>core/</code> - Factor core library</li>
  52 <li><code>basis/</code> - Factor basis library, compiler, tools</li>
  53 <li><code>extra/</code> - more libraries and applications</li>
  54 <li><code>misc/</code> - editor modes, icons, etc</li>
  55 <li><code>unmaintained/</code> - unmaintained contributions, please
  56 help!</li>
  57
  58 <h2>Community</h2>
  59
  60 <p>Factor developers meet in the <code>#concatenative</code> channel on <a
  61 href="http://freenode.net">irc.freenode.net</a>. Drop by if you want to discuss
  62 anything related to Factor or language design in general.</p>
  63
  64 <ul>
  65 <li><a href="http://factorcode.org">Factor homepage</a></li>
  66 <li><a href="http://concatenative.org">Concatenative languages wiki</a></li>
  67 </ul>
  68
  69 <p>Have fun!</p>
  70
  71 </body>
  72 </html>