From 595f120ecdd3c6bddcbb733e6f262edfad41d7e6 Mon Sep 17 00:00:00 2001 From: Derick Alangi Date: Tue, 8 Jun 2021 17:21:15 +0100 Subject: [PATCH] A quick documentation on how to run a pocketlang program locally (#45) * A quick documentation on how to run a pocketlang program locally With a small factorial program written in pocketlang and executed on the terminal, this demonstrates how to execute a script on a loalhost using pocketlang binary * Apply changes requested in review #1 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 56e8912..4effc8d 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,30 @@ It's a [WebAssembly](https://webassembly.org/) build of the VM compiled using [e Note that in the webassembly version of the language, some features (input, relative import, etc.) have disabled, has limited memory allocations, and the IO calls might be slower. +### On Your System + +NOTE: Make sure you've compiled the `pocketlang` source code and you have the `pocket` binary in `build/debug/`. + +Copy/paste or type in the following factorial code in any editor of your choice: + +```ruby +# A recursive factorial function +def fac(n) + if n == 0 then return 1 end + return n*fac(n-1) +end + +# Prints all factorials from 0 to 10 exclusive. +print('Factorial of 0 - 9\n') +for i in 0..10 + print(fac(i)) +end +``` + +Save the file as `factorial.pk` and execute it from your pocketlang directory with: `./build/debug/pocket /factorial.pk`. + +This should print out the output of the factorial program in your STDOUT (terminal). + ## Documentation The pocketlang documentation is hosted at https://thakeenathees.github.io/pocketlang/ which