fix: add missing vocabulary in example

[factor.git] / README.md

diff --git a/README.md b/README.md
index 9ea80519ae98625d4aa3c2b3af7807f5731ad811..4a746f0c95ebd3b9a8df8d6d92d94570c7867af6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # Factor
 
+[![](https://api.travis-ci.org/factor/factor.svg)](https://travis-ci.org/factor/factor)
+
 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)
@@ -28,17 +30,18 @@ a boot image stored on factorcode.org.
 
 To check out Factor:
 
-* `git clone git://factorcode.org/git/factor.git`
+* `git clone git://github.com/factor/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`
+* Windows: `build.cmd`
+* M1 macOS: `arch -x86_64 ./build.sh update`
 
 or download the correct boot image for your system from
-http://downloads.factorcode.org/images/master/, put it in the factor
+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`
@@ -46,6 +49,10 @@ directory and run:
 
 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.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).
 
@@ -75,7 +82,7 @@ Some other simple things you can try in the listener:
 
 1000 [1,b] sum .
 
-4 <iota>  [
+4 <iota> [
     "Happy Birthday " write
     2 = "dear NAME" "to You" ? print
 ] each
@@ -127,6 +134,25 @@ The Factor source tree is organized as follows:
 * `misc/` - editor modes, icons, etc
 * `unmaintained/` - now at [factor-unmaintained](https://github.com/factor/factor-unmaintained)
 
+## Source History
+
+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.
+
+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
@@ -135,5 +161,7 @@ anything related to Factor or language design in general.
 
 * [Factor homepage](https://factorcode.org)
 * [Concatenative languages wiki](https://concatenative.org)
+* [Mailing list](factor-talk@lists.sourceforge.net)
+* Search for "factorcode" on [Gitter](https://gitter.im/)
 
 Have fun!