Go to file
Doug Coleman aa7f22edc0 Cleanup vocab name validation. Vocab names and vocab prefixes are the same concept, and by disallowing slashes, spaces, and colon, we automatically check for absolute paths. Unit test this. 2011-10-29 01:05:37 -07:00
Factor.app/Contents updated copyright 2011-05-04 17:19:30 -07:00
basis Cleanup vocab name validation. Vocab names and vocab prefixes are the same concept, and by disallowing slashes, spaces, and colon, we automatically check for absolute paths. Unit test this. 2011-10-29 01:05:37 -07:00
build-support factor.sh: Make net-bootstrap recompile the vm, add make_clean_factor function 2011-10-29 01:05:37 -07:00
core Cleanup vocab name validation. Vocab names and vocab prefixes are the same concept, and by disallowing slashes, spaces, and colon, we automatically check for absolute paths. Unit test this. 2011-10-29 01:05:37 -07:00
extra mason.git: cleanup 2011-10-28 21:53:39 -07:00
misc factor.vim: fix syntax highlight for exponentials (i.e. "1.5e10"). 2011-09-21 19:29:56 -07:00
unmaintained Remove stack effects from HELP: declarations. 2011-10-20 19:36:11 -07:00
vm vm: give factorbug a help command 2011-10-27 21:18:23 -07:00
work
.gitignore
GNUmakefile Move --no-as-needed to Config.linux since it breaks compilation on mac 2011-10-19 12:09:43 -07:00
Nmakefile vm: update windows for resumable signals 2011-10-27 21:18:21 -07:00
license.txt
readme.html

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/Learning">Learning Factor</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>