X-Git-Url: https://gitweb.factorcode.org/gitweb.cgi?p=factor.git;a=blobdiff_plain;f=README.md;h=f69589aa048950de49b2eb052f1ea948500301ef;hp=4d6e34813f16d485d9d727ab5c8b3307eda5edee;hb=HEAD;hpb=c7959f2cb288f1a756c8f2c342b26a5a226668c0 diff --git a/README.md b/README.md index 4d6e34813f..4d43adb7b3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Factor +![Build](https://github.com/factor/factor/actions/workflows/build.yml/badge.svg) + 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,7 +30,7 @@ a boot image stored on factorcode.org. To check out Factor: -* `git clone git://github.com/factor/factor.git` +* git clone https://github.com/factor/factor.git * `cd factor` To build the latest complete Factor system from git, either use the @@ -36,9 +38,10 @@ 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 -http://downloads.factorcode.org/images/master/, put it in the `factor` +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` @@ -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.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). @@ -60,12 +67,26 @@ The nightly builds are usually a better experience than the point releases. ### Learning Factor -A tutorial is available that can be accessed from the Factor environment: +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 @@ -73,7 +94,7 @@ Some other simple things you can try in the listener: { 4 8 15 16 23 42 } [ 2 * ] map . -1000 [1,b] sum . +1000 [1..b] sum . 4 [ "Happy Birthday " write @@ -129,7 +150,7 @@ The Factor source tree is organized as follows: ## 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. +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/*'` @@ -148,13 +169,12 @@ 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](https://factorcode.org) * [Concatenative languages wiki](https://concatenative.org) -* [Mailing list](factor-talk@lists.sourceforge.net) +* [Join the mailing list](https://concatenative.org/wiki/view/Factor/Mailing%20list) * Search for "factorcode" on [Gitter](https://gitter.im/) Have fun!