README.md

   1 # Factor
   2
   3 ![Build](https://github.com/factor/factor/actions/workflows/build.yml/badge.svg)
   4
   5 Factor is a [concatenative](https://www.concatenative.org), stack-based
   6 programming language with [high-level
   7 features](https://concatenative.org/wiki/view/Factor/Features/The%20language)
   8 including dynamic types, extensible syntax, macros, and garbage collection.
   9 On a practical side, Factor has a [full-featured
  10 library](https://docs.factorcode.org/content/article-vocab-index.html),
  11 supports many different platforms, and has been extensively documented.
  12
  13 The implementation is [fully
  14 compiled](https://concatenative.org/wiki/view/Factor/Optimizing%20compiler)
  15 for performance, while still supporting [interactive
  16 development](https://concatenative.org/wiki/view/Factor/Interactive%20development).
  17 Factor applications are portable between all common platforms.  Factor can
  18 [deploy stand-alone
  19 applications](https://concatenative.org/wiki/view/Factor/Deployment) on all
  20 platforms.  Full source code for the Factor project is available under a BSD
  21 license.
  22
  23 ## Getting Started
  24
  25 ### Building Factor from source
  26
  27 If you have a build environment set up, then you can build Factor from git.
  28 These scripts will attempt to compile the Factor binary and bootstrap from
  29 a boot image stored on factorcode.org.
  30
  31 To check out Factor:
  32
  33 * git clone https://github.com/factor/factor.git
  34 * `cd factor`
  35
  36 To build the latest complete Factor system from git, either use the
  37 build script:
  38
  39 * Unix: `./build.sh update`
  40 * Windows: `build.cmd`
  41 * M1 macOS: `arch -x86_64 ./build.sh update`
  42
  43 or download the correct boot image for your system from
  44 https://downloads.factorcode.org/images/master/, put it in the `factor`
  45 directory and run:
  46
  47 * Unix: `make` and then `./factor -i=boot.unix-x86.64.image`
  48 * Windows: `nmake /f Nmakefile x86-64` and then `factor.com -i=boot.windows-x86.64.image`
  49
  50 Now you should have a complete Factor system ready to run.
  51
  52 Factor does not yet work on arm64 cpus. There is an arm64 assembler
  53 in `cpu.arm.64.assembler` and we are working on a port and also looking for
  54 contributors.
  55
  56 More information on [building factor](https://concatenative.org/wiki/view/Factor/Building%20Factor)
  57 and [system requirements](https://concatenative.org/wiki/view/Factor/Requirements).
  58
  59 ### To run a Factor binary:
  60
  61 You can download a Factor binary from the grid on [https://factorcode.org](https://factorcode.org).
  62 The nightly builds are usually a better experience than the point releases.
  63
  64 * Windows: Double-click `factor.exe`, or run `.\factor.com` in a command prompt
  65 * Mac OS X: Double-click `Factor.app` or run `open Factor.app` in a Terminal
  66 * Unix: Run `./factor` in a shell
  67
  68 ### Learning Factor
  69
  70 A tutorial is available that can be accessed from the Factor environment:
  71
  72 ```factor
  73 "first-program" help
  74 ```
  75
  76 Some demos that are included in the distribution to show off various features:
  77
  78 ```factor
  79 "demos" run
  80 ```
  81
  82 Some other simple things you can try in the listener:
  83
  84 ```factor
  85 "Hello, world" print
  86
  87 { 4 8 15 16 23 42 } [ 2 * ] map .
  88
  89 1000 [1..b] sum .
  90
  91 4 <iota> [
  92     "Happy Birthday " write
  93     2 = "dear NAME" "to You" ? print
  94 ] each
  95 ```
  96
  97 For more tips, see [Learning Factor](https://concatenative.org/wiki/view/Factor/Learning).
  98
  99 ## Documentation
 100
 101 The Factor environment includes extensive reference documentation and a
 102 short "cookbook" to help you get started. The best way to read the
 103 documentation is in the UI; press F1 in the UI listener to open the help
 104 browser tool. You can also [browse the documentation
 105 online](https://docs.factorcode.org).
 106
 107 ## Command Line Usage
 108
 109 Factor supports a number of command line switches:
 110
 111 ```
 112 Usage: factor [Factor arguments] [script] [script arguments]
 113
 114 Common arguments:
 115     -help            print this message and exit
 116     -i=<image>       load Factor image file <image> (default factor.image)
 117     -run=<vocab>     run the MAIN: entry point of <vocab>
 118         -run=listener    run terminal listener
 119         -run=ui.tools    run Factor development UI
 120     -e=<code>        evaluate <code>
 121     -ea=<code>       evaluate <code> with auto-use
 122     -no-user-init    suppress loading of .factor-rc
 123     -roots=<paths>   a list of path-delimited extra vocab roots
 124
 125 Enter
 126     "command-line" help
 127 from within Factor for more information.
 128 ```
 129
 130 You can also write scripts that can be run from the terminal, by putting
 131 ``#!/path/to/factor`` at the top of your scripts and making them executable.
 132
 133 ## Source Organization
 134
 135 The Factor source tree is organized as follows:
 136
 137 * `vm/` - Factor VM source code (not present in binary packages)
 138 * `core/` - Factor core library
 139 * `basis/` - Factor basis library, compiler, tools
 140 * `extra/` - more libraries and applications
 141 * `misc/` - editor modes, icons, etc
 142 * `unmaintained/` - now at [factor-unmaintained](https://github.com/factor/factor-unmaintained)
 143
 144 ## Source History
 145
 146 During Factor's lifetime, sourcecode has lived in many repositories. Unfortunately, the first import in Git did not keep history. History has been partially recreated from what could be salvaged. Due to the nature of Git, it's only possible to add history without disturbing upstream work, by using replace objects. These need to be manually fetched, or need to be explicitly added to your git remote configuration.
 147
 148 Use:
 149 `git fetch origin 'refs/replace/*:refs/replace/*'`
 150
 151 or add the following line to your configuration file
 152
 153 ```
 154 [remote "origin"]
 155     url = ...
 156     fetch = +refs/heads/*:refs/remotes/origin/*
 157     ...
 158     fetch = +refs/replace/*:refs/replace/*
 159 ```
 160
 161 Then subsequent fetches will automatically update any replace objects.
 162
 163 ## Community
 164
 165 Factor developers are quite active in [the Factor Discord server](https://discord.gg/QxJYZx3QDf).
 166 Drop by if you want to discuss anything related to Factor or language design in general.
 167
 168 * [Factor homepage](https://factorcode.org)
 169 * [Concatenative languages wiki](https://concatenative.org)
 170 * [Join the mailing list](https://concatenative.org/wiki/view/Factor/Mailing%20list)
 171 * Search for "factorcode" on [Gitter](https://gitter.im/)
 172
 173 Have fun!