Go to file
Björn Lindqvist 5edc976941 google.gmail: vocab needs some docs 2018-02-04 21:53:08 +01:00
Factor.app/Contents Factor.app: update copyright. 2017-06-11 14:16:53 -07:00
basis v0.2 help.lint.pedantic: move to extra 2018-02-03 14:58:32 -08:00
core sorting: simplify l-next, r-next. 2018-01-22 11:45:54 -08:00
extra google.gmail: vocab needs some docs 2018-02-04 21:53:08 +01:00
misc FUEL: fix rendering of $synopsis markup. 2018-02-01 15:43:27 +01:00
vm cast fixes undefined behaviour; closes #1919 in upstream 2018-01-31 17:15:54 +01:00
work Add file to work dir to ensure it gets checked in 2008-09-12 04:36:32 -05:00
.dir-locals.el FUEL: fix name of customization variable 2016-07-13 17:34:40 +02:00
.gitattributes Add .gitattributes to enforce EOL policy for factor sources 2017-06-05 13:58:08 -07:00
.gitignore .gitignore: remove temp so that we can search io.files.temp. remove 2016-03-17 02:40:29 -07:00
.travis.yml travis: DEBUG build, makes factor slower but catches more errors (hopefully) 2018-01-31 18:26:46 +01:00
GNUmakefile Build: let's remove the NO_UI variable 2017-06-30 00:24:24 +02:00
LICENSE.txt LICENSE.txt: update year. 2018-01-18 20:12:24 -08:00
Nmakefile Nmakefile: add the /largeaddressaware linker option for 32-bit builds 2017-06-04 00:11:35 -05:00
README.md README.md: remove extra space. 2018-01-22 11:50:09 -08:00
build.cmd build.cmd: Get boot images from the branch you're on. 2017-12-09 01:42:55 -06:00
build.sh build.sh: change apt-get to apt 2017-12-27 23:21:57 -08:00

README.md

Factor

Factor is a concatenative, stack-based programming language with high-level features including dynamic types, extensible syntax, macros, and garbage collection. On a practical side, Factor has a full-featured library, supports many different platforms, and has been extensively documented.

The implementation is fully compiled for performance, while still supporting interactive development. Factor applications are portable between all common platforms. Factor can deploy stand-alone applications on all platforms. Full source code for the Factor project is available under a BSD license.

Getting Started

Building Factor from source

If you have a build environment set up, then you can build Factor from git. These scripts will attempt to compile the Factor binary and bootstrap from a boot image stored on factorcode.org.

To check out Factor:

  • git clone git://factorcode.org/git/factor.git
  • cd factor

To build the latest complete Factor system from git, either use the build script:

  • Windows: build.cmd
  • Unix: ./build.sh update

or download the correct boot image for your system from http://downloads.factorcode.org/images/master/, put it in the factor directory and run:

  • Unix: make and then ./factor -i=boot.unix-x86.64.image
  • Windows: nmake /f Nmakefile x86-64 and then factor.com -i=boot.windows-x86.64.image

Now you should have a complete Factor system ready to run.

More information on building factor and system requirements.

To run a Factor binary:

You can download a Factor binary from the grid on https://factorcode.org. The nightly builds are usually a better experience than the point releases.

  • Windows: Double-click factor.exe, or run .\factor.com in a command prompt
  • Mac OS X: Double-click Factor.app or run open Factor.app in a Terminal
  • Unix: Run ./factor in a shell

Learning Factor

A tutorial is available that can be accessed from the Factor environment:

"first-program" help

Some other simple things you can try in the listener:

"Hello, world" print

{ 4 8 15 16 23 42 } [ 2 * ] map .

1000 [1,b] sum .

4 <iota> [
    "Happy Birthday " write
    2 = "dear NAME" "to You" ? print
] each

For more tips, see Learning Factor.

Documentation

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 browse the documentation online.

Command Line Usage

Factor supports a number of command line switches:

Usage: factor [Factor arguments] [script] [script arguments]

Common arguments:
    -help            print this message and exit
    -i=<image>       load Factor image file <image> (default factor.image)
    -run=<vocab>     run the MAIN: entry point of <vocab>
        -run=listener    run terminal listener
        -run=ui.tools    run Factor development UI
    -e=<code>        evaluate <code>
    -no-user-init    suppress loading of .factor-rc
    -roots=<paths>   a list of path-delimited extra vocab roots

Enter
    "command-line" help
from within Factor for more information.

You can also write scripts that can be run from the terminal, by putting #!/path/to/factor at the top of your scripts and making them executable.

Source Organization

The Factor source tree is organized as follows:

  • vm/ - Factor VM source code (not present in binary packages)
  • core/ - Factor core library
  • basis/ - Factor basis library, compiler, tools
  • extra/ - more libraries and applications
  • misc/ - editor modes, icons, etc
  • unmaintained/ - now at factor-unmaintained

Community

Factor developers meet in the #concatenative channel on irc.freenode.net. Drop by if you want to discuss anything related to Factor or language design in general.

Have fun!