Go to file
Doug Coleman cb84fefc37 webapps.help: Load the navbar from a Factor word instead of hardcoding it into the template so that the glossary link works. 2011-11-06 12:16:46 -08:00
Factor.app/Contents updated copyright 2011-05-04 17:19:30 -07:00
basis html.components: For the t:html tag, only wrap strings in unescaped so that other objects can render. 2011-11-06 12:15:00 -08:00
build-support remove lingering mentions of macosx-ppc 2011-11-02 18:40:27 -07:00
core Make the require-hook throw an error if the vocabulary does not exist in the dictionary or on disk. Move require docs to vocabs. Add unit tests for require. Fixes #339. 2011-11-03 11:39:34 -07:00
extra webapps.help: Load the navbar from a Factor word instead of hardcoding it into the template so that the glossary link works. 2011-11-06 12:16:46 -08:00
misc Handle auto-user in fuel-connection.el. Fix suggested by Eungju Park. 2011-11-02 18:14:10 -07:00
unmaintained Make "foo.private" require load foo instead. 2011-11-02 11:50:03 -07:00
vm switch back to gcc from clang since it goes faster 2011-11-04 00:09:30 -07: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 makefile: add macosx-x86-fat target 2011-11-03 20:19:37 -07:00
Nmakefile vm: groundwork for sampling profiler 2011-11-02 13:23:06 -07:00
license.txt Remove copyright notice from license 2009-04-21 16:25:04 -05:00
readme.html Update readme.html, because "Getting started" has moved 2011-03-05 21:54:12 +09: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/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>