Go to file
Doug Coleman c2bdb133d6 Don't build the Factor dll twice on Windows 2010-01-18 05:21:50 -06: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 compiler.tree.escape-analysis: make tests a bit more robust; a change to boa constructors recently meant dead curries were showing up on certain expansions, this was throwing off the escape-analysis test's unboxed allocation counting. Fix this by having the test run DCE first, and remove a few tests that no longer make sense now 2010-01-18 23:32:34 +13:00
build-support vm: Tweak Factor VM to compile with Microsoft Visual Studio on Windows, in addition to Mingw. Add an Nmakefile which can be used for this purpose. Rename Makefile to GNUmakefile. 2010-01-17 03:43:22 +13:00
core Stop wearing monocle and use the term "entry point" instead of "XT" throughout VM and compiler; also remove two unused relocation types 2010-01-18 20:54:00 +13:00
extra method-chains docs 2010-01-16 23:13:59 -08:00
misc sigma -> map-sum 2009-10-29 14:34:04 -05:00
unmaintained Factor source files should not be executable 2009-11-21 17:50:43 -06:00
vm Stop wearing monocle and use the term "entry point" instead of "XT" throughout VM and compiler; also remove two unused relocation types 2010-01-18 20:54:00 +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 Don't build the Factor dll twice on Windows 2010-01-18 05:21:50 -06:00
Nmakefile Nmakefile: build factor.dll and link in resource file 2010-01-16 22:41:17 -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>