Go to file
Doug Coleman 9840e5e147 Add a combinator to make a unique directory, set that to the current and temp directories, and then delete the directory when done. Useful when working with apps that need to write intermediate files to the current directory 2010-06-13 19:34:17 -05:00
Factor.app/Contents Bump version number to 0.94 2010-04-16 23:41:50 -05:00
basis Add a combinator to make a unique directory, set that to the current and temp directories, and then delete the directory when done. Useful when working with apps that need to write intermediate files to the current directory 2010-06-13 19:34:17 -05:00
build-support build-support/factor.cmd: cleanups recommended by mnestic 2010-05-25 21:32:07 -07:00
core Sets docs -- testing set membership: member? -> in? 2010-06-05 18:55:46 -05:00
extra io.encodings.detect: detect empty files as utf8 rather than raise a sequence error 2010-06-13 19:34:16 -05:00
misc Remove ENUM: f and replace uses with CONSTANTs. 2010-04-19 20:08:40 -07:00
unmaintained Remove ENUM: f and replace uses with CONSTANTs. 2010-04-19 20:08:40 -07:00
vm Use ##local-allot to simplify longlong unboxing 2010-05-19 01:07:22 -04:00
work Add file to work dir to ensure it gets checked in 2008-09-12 04:36:32 -05:00
.gitignore gitignore the fresh boot image 2010-04-25 15:16:08 -05:00
GNUmakefile GNUmakefile: build factor shared library by default again 2010-04-20 15:28:09 -07:00
Nmakefile Nmakefile: delete factor.res when cleaning 2010-06-04 17:03:33 -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>