X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=forth.jl.git;a=blobdiff_plain;f=README.md;h=18ba803ae1112f85d49a54ad10d143e91eb1261c;hp=0a0b287743c14fe0dabc598e93c59e9711e49e4f;hb=b10ceb9040d2a15490408e0d0a75931d80e259cf;hpb=0c38ac60ab45dd1f3db641b36a8a822862080e7e diff --git a/README.md b/README.md index 0a0b287..18ba803 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ that which it has already fulfilled: forcing me to think quite carefully about how forth works. This package owes a massive debt to the existence of the literate programming -project [JonesForth] (https://rwmj.wordpress.com/2010/08/07/jonesforth-git-repository/), +project [JonesForth](https://rwmj.wordpress.com/2010/08/07/jonesforth-git-repository/), which was an amazing read. To a large degree my package is simply a port of that project from x86 assembly + forth to julia + forth, although the mapping is in a few places non-trivial due to the fact that julia is a high level @@ -22,9 +22,13 @@ high-level grounding, but that will have to wait for another time. ## Installation forth.jl is not (and probably will never be) a registered julia package. To -install it, you will therefore need to use the following command: +install it, you will therefore need to use the following command from the +Julia package manager (accessed using the `]` key): - julia> Pkg.clone("https://github.com/tgvaughan/forth.jl") + (v1.0) pkg> add https://github.com/tgvaughan/forth.jl + +Be aware that **forth.jl requires Julia 1.0**. (Incompatabilities exist between +0.6 and previous versions of julia, particularly the handling of [world age](https://github.com/JuliaLang/julia/pull/17057).) ## Usage @@ -42,9 +46,7 @@ the library file. Once this is complete you can start entering forth commands: There's an example Mandelbrot Set drawing program included in the examples directory. To run it, use the `INCLUDE-LIB` word to open the file and compile its -definitions. Although the exact location of the examples directory in your -filesystem is platform dependent, `INCLUDE-LIB` includes the forth.jl src/ directory -in its search path so the following should always work: +definitions: include-lib ../examples/mandelbrot.4th Enter 'mandel' to draw the Mandelbrot Set. ok @@ -80,7 +82,9 @@ in its search path so the following should always work: ** ok -To exit, enter ^D on a blank line or use the `BYE` word. +(`INCLUDE-LIB` is exactly like INCLUDE, but includes files relative to thte +platform-dependent forth.jl src/ directory.) To exit, enter ^D on a blank line +or use the `BYE` word. ## FORTH-83 Compliance