Go to file
Joe Groff 44ba9e086e opengl.gl.extensions: annoying hack to make gpu.* demos work in Lion. opengl 3 entry points such as glGenVertexArrays are available, but they only actually work in core profile contexts which factor doesn't support yet, so favor extension entry points such as glGenVertexArraysAPPLE instead of standard entry points 2011-07-29 14:15:59 -07:00
Factor.app/Contents new icns file for OS X 2010-07-05 20:53:24 -07:00
basis opengl.gl.extensions: annoying hack to make gpu.* demos work in Lion. opengl 3 entry points such as glGenVertexArrays are available, but they only actually work in core profile contexts which factor doesn't support yet, so favor extension entry points such as glGenVertexArraysAPPLE instead of standard entry points 2011-07-29 14:15:59 -07:00
build-support 32 and 64 bit Linux PPC support 2011-05-23 23:36:14 -04:00
core strings: a few more peace-of-mind tests setting out-of-range code points in strings 2011-07-20 13:52:42 -07:00
extra Fix mason following PPC changes; target-os and target-cpu are no longer strings. 2011-07-29 01:57:14 -04:00
misc misc/vim/syntax/factor.vim: merge two factorComment highlight groups together into one 2011-04-06 15:28:59 +09:00
unmaintained 32 and 64 bit Linux PPC support 2011-05-23 23:36:14 -04:00
vm Remove unnecessary -std=gnu99 2011-06-23 01:17:24 -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 32 and 64 bit Linux PPC support 2011-05-23 23:36:14 -04:00
Nmakefile Squashed commit of the following: 2010-09-19 19:13:25 -05: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>