Go to file
Slava Pestov e5e51c40a1 vm: implement frame-based SEH for 64-bit Windows 2010-04-08 10:32:14 -07:00
Factor.app/Contents Bump version number to 0.93 2010-02-17 00:16:08 +13:00
basis ui.gadgets.grids: clarify docs 2010-04-08 10:22:59 -07:00
build-support Support unix-x86.32 and winnt-x86.32 boot images in factor.sh 2010-04-04 14:39:59 -05:00
core combinators: fix load error 2010-04-06 16:48:30 -04:00
extra cursors: unify input-cursor and assoc-cursor, give all cursors a "key" concept 2010-04-06 15:20:56 -07:00
misc FUEL syntax updates 2010-03-02 19:32:07 -08:00
unmaintained Move closures, fries and set-n to unmaintained 2010-02-24 20:24:32 +13:00
vm vm: implement frame-based SEH for 64-bit Windows 2010-04-08 10:32:14 -07:00
work Add file to work dir to ensure it gets checked in 2008-09-12 04:36:32 -05:00
.gitignore gitignore .RES 2010-02-05 14:10:53 -06:00
GNUmakefile statically link factor executable to VM so dylib is only needed for embedding 2010-04-01 14:25:02 -07:00
Nmakefile vm: implement frame-based SEH for 64-bit Windows 2010-04-08 10:32:14 -07:00
license.txt Remove copyright notice from license 2009-04-21 16:25:04 -05:00
readme.html fix busted html in readme.html 2009-10-28 21:03:53 -05:00

readme.html

<html>
<head><title>Factor</title></head>

<body>
<h1>The Factor programming language</h1>

<h2>Getting started</h2>

<p>If you are reading this README file, you either downloaded a binary
package, or checked out Factor sources from the GIT repository.</p>

<ul>
<li><a href="http://concatenative.org/wiki/view/Factor/Getting%20started">Getting started</a></li>
<li><a href="http://concatenative.org/wiki/view/Factor/Requirements">System requirements</a></li>
<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>
</ul>

<p>To run Factor:<p>

<ul>
<li>Windows: Double-click <code>factor.exe</code>, or run
<code>.\factor.com</code> in a command prompt</li>
<li>Mac OS X: Double-click <code>Factor.app</code> or run <code>open
Factor.app</code> in a Terminal</li>
<li>Unix: Run <code>./factor</code> in a shell</li>
</ul>

<h2>Documentation</h2>

<p>The Factor environment includes extensive reference documentation and
a short "cookbook" to help you get started. The best way to read the
documentation is in the UI; press F1 in the UI listener to open the help
browser tool. You can also <a href="http://docs.factorcode.org">browse
the documentation online</a>.</p>

<h2>Command line usage</h2>

<p>Factor supports a number of command line switches. To read command line
usage documentation, enter the following in the UI listener:</p>

<pre>"command-line" about</pre>

<h2>Source organization</h2>

The Factor source tree is organized as follows:

<li><code>build-support/</code> - scripts used for compiling Factor (not
present in binary packages)</li>
<li><code>vm/</code> - Factor VM source code (not present in binary
packages)</li>
<li><code>core/</code> - Factor core library</li>
<li><code>basis/</code> - Factor basis library, compiler, tools</li>
<li><code>extra/</code> - more libraries and applications</li>
<li><code>misc/</code> - editor modes, icons, etc</li>
<li><code>unmaintained/</code> - unmaintained contributions, please
help!</li>

<h2>Community</h2>

<p>Factor developers meet in the <code>#concatenative</code> channel on <a
href="http://freenode.net">irc.freenode.net</a>. Drop by if you want to discuss
anything related to Factor or language design in general.</p>

<ul>
<li><a href="http://factorcode.org">Factor homepage</a></li>
<li><a href="http://concatenative.org">Concatenative languages wiki</a></li>
</ul>

<p>Have fun!</p>

</body>
</html>