README: adding travis graphic.

[factor.git] / README.md

diff --git a/README.md b/README.md
index 6c042a90043753044ef8259ff8f2c69105f83050..f3c703be4ce5763ab2cdc82df23fb0dd68062690 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
 # 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)
 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. 
+supports many different platforms, and has been extensively documented.
 
 The implementation is [fully
 compiled](https://concatenative.org/wiki/view/Factor/Optimizing%20compiler)
@@ -28,13 +30,21 @@ 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:
+To build the latest complete Factor system from git, either use the
+build script:
 
-* Windows: `build.cmd`
 * Unix: `./build.sh update`
+* Windows: `build.cmd`
+
+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.
 
@@ -67,7 +77,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
@@ -117,7 +127,26 @@ The Factor source tree is organized as follows:
 * `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, 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
 
@@ -127,5 +156,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!