Go to file
Slava Pestov 7846074b3b db: update for ERROR: change 2010-02-03 23:11:31 +13:00
Factor.app/Contents move "run factor file" and "save factor image" commands to application menu 2009-06-21 20:57:54 -05:00
basis db: update for ERROR: change 2010-02-03 23:11:31 +13:00
build-support build-support/cleanup: clean up 'images' directory after testing 2010-01-20 03:15:11 +13:00
core Documentation improvements 2010-02-03 23:11:30 +13:00
extra prettyprint.callables: not needed anymore since fry output is prettier 2010-02-03 23:11:29 +13:00
misc Make TUPLE: indent, which seems to be the common indentation. 2010-01-27 15:31:08 -08:00
unmaintained Merge up 2010-01-30 20:39:43 -08:00
vm vm: modify-code-heap primitive now takes a pair of parameters, update-existing? and reset-pics?. If no generic words were changed, PICs do not need to be reset. If no existing words were redefined, the code heap doesn't have to be traced at all. Speeds up compilation of PEGs since those create lots of compilation units 2010-02-03 23:11:28 +13:00
work Add file to work dir to ensure it gets checked in 2008-09-12 04:36:32 -05:00
.gitignore Remove generated file factor.res added by mistake 2010-01-17 18:00:26 +13:00
GNUmakefile Delete .lib objects from Visual Studio if they exist. gcc doesn't build them, yet tries to use them if they exist... 2010-01-22 12:59:39 -06:00
Nmakefile Fix ffi-test library to work with Windows SDK. Turns out MINGW has a different ABI for struct returns than MS's compiler; make the MS ABI the default for cdecl on Windows, and add mingw ABI for libraries that use the MINGW ABI 2010-02-02 04:01:12 -06: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>