# Factor
-The Factor programming language combines [powerful language
-features](http://concatenative.org/wiki/view/Factor/Features/The%20language)
-with a [full-featured
-library](http://docs.factorcode.org/content/article-vocab-index.html). The
-implementation is [fully
-compiled](http://concatenative.org/wiki/view/Factor/Optimizing%20compiler)
+
+
+Factor is a [concatenative](https://www.concatenative.org), stack-based
+programming language with [high-level
+features](https://concatenative.org/wiki/view/Factor/Features/The%20language)
+including dynamic types, extensible syntax, macros, and garbage collection.
+On a practical side, Factor has a [full-featured
+library](https://docs.factorcode.org/content/article-vocab-index.html),
+supports many different platforms, and has been extensively documented.
+
+The implementation is [fully
+compiled](https://concatenative.org/wiki/view/Factor/Optimizing%20compiler)
for performance, while still supporting [interactive
-development](http://concatenative.org/wiki/view/Factor/Interactive%20development).
+development](https://concatenative.org/wiki/view/Factor/Interactive%20development).
Factor applications are portable between all common platforms. Factor can
[deploy stand-alone
-applications](http://concatenative.org/wiki/view/Factor/Deployment) on all
+applications](https://concatenative.org/wiki/view/Factor/Deployment) on all
platforms. Full source code for the Factor project is available under a BSD
license.
## Getting Started
-If you are reading this README file, you either downloaded a binary
-package, or checked out Factor sources from the GIT repository.
+### Building Factor from source
-* [Learning Factor](http://concatenative.org/wiki/view/Factor/Learning)
-* [System requirements](http://concatenative.org/wiki/view/Factor/Requirements)
-* [Building Factor from source](http://concatenative.org/wiki/view/Factor/Building%20Factor) (don't do this if you're using a binary package)
+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 run Factor:
+To check out Factor:
+
+* git clone https://github.com/factor/factor.git
+* `cd factor`
+
+To build the latest complete Factor system from git, either use the
+build script:
+
+* Unix: `./build.sh update`
+* Windows: `build.cmd`
+* M1 macOS: `arch -x86_64 ./build.sh update`
+
+or download the correct boot image for your system from
+https://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.
+
+Factor does not yet work on arm64 cpus. There is an arm64 assembler
+in `cpu.arm.64.assembler` and we are working on a port and also looking for
+contributors.
+
+More information on [building factor](https://concatenative.org/wiki/view/Factor/Building%20Factor)
+and [system requirements](https://concatenative.org/wiki/view/Factor/Requirements).
+
+### To run a Factor binary:
+
+You can download a Factor binary from the grid on [https://factorcode.org](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
-A tutorial is available that can be accessed from the Factor environment:
+### Learning Factor
+
+A [tutorial](https://docs.factorcode.org/content/article-first-program.html)
+is available that can be accessed from the Factor environment:
```factor
"first-program" help
```
+Take a look at a [guided
+tour](https://docs.factorcode.org/content/article-tour.html) of Factor:
+
+```factor
+"tour" help
+```
+
+Some demos that are included in the distribution to show off various features:
+
+```factor
+"demos" run
+```
+
Some other simple things you can try in the listener:
```factor
{ 4 8 15 16 23 42 } [ 2 * ] map .
-1000 [1,b] sum .
+1000 [1..b] sum .
-4 iota [
+4 <iota> [
"Happy Birthday " write
2 = "dear NAME" "to You" ? print
] each
```
+For more tips, see [Learning Factor](https://concatenative.org/wiki/view/Factor/Learning).
+
## 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](http://docs.factorcode.org).
+online](https://docs.factorcode.org).
## Command Line Usage
-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
The Factor source tree is organized as follows:
-* `build-support/` - scripts used for compiling Factor (not present in binary packages)
* `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/` - unmaintained contributions, please help!
+* `unmaintained/` - now at [factor-unmaintained](https://github.com/factor/factor-unmaintained)
+
+## Source History
+
+During Factor's lifetime, source code 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.
+
+Use:
+`git fetch origin 'refs/replace/*:refs/replace/*'`
+
+or add the following line to your configuration file
+
+```
+[remote "origin"]
+ url = ...
+ fetch = +refs/heads/*:refs/remotes/origin/*
+ ...
+ fetch = +refs/replace/*:refs/replace/*
+```
+
+Then subsequent fetches will automatically update any replace objects.
## Community
-Factor developers meet in the `#concatenative` channel on
-[irc.freenode.net](http://freenode.net). Drop by if you want to discuss
-anything related to Factor or language design in general.
+Factor developers are quite active in [the Factor Discord server](https://discord.gg/QxJYZx3QDf).
+Drop by if you want to discuss anything related to Factor or language design in general.
-* [Factor homepage](http://factorcode.org)
-* [Concatenative languages wiki](http://concatenative.org)
+* [Factor homepage](https://factorcode.org)
+* [Concatenative languages wiki](https://concatenative.org)
+* [Join the mailing list](https://concatenative.org/wiki/view/Factor/Mailing%20list)
+* Search for "factorcode" on [Gitter](https://gitter.im/)
Have fun!
projects / factor.git / blobdiff