From cda62b66e5d2cc0c7e8dd5c10bb49eb8cfa46c57 Mon Sep 17 00:00:00 2001 From: Atreya Bain Date: Tue, 20 Feb 2024 22:58:44 +0530 Subject: [PATCH] [doc] README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76cd15b..9997f2a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # BytePusher Emulator This is a play at emulating a BytePusher machine developed by [Javamannen](https://esolangs.org/wiki/User:Javamannen). +Binary builds for linux x86_64 is available in GitHub Action runs. ![Screen test](assets/screen_test.png) Screenshot program author: [Javamannen](https://esolangs.org/wiki/User:Javamannen) @@ -16,13 +17,22 @@ Screenshot program author: [Javamannen](https://esolangs.org/wiki/User:Javamanne - [X] SDL2 adapter - [X] Keyboard - [X] Audio -- [ ] Load/Save memory - - [X] Load a ROM +- [X] Load a ROM ## Usage instructions -TBD +For help on how to use, please refer +```sh +./byte-pusher-emu --help +``` +To load a program, use the following command. + +```sh +./byte-pusher-emu -f rom.BytePusher +``` + +Loads a rom from the file specified. If `-f` is not mentioned, the VM will run with an empty memory (which will cause it to cycle endlessly). ## More information about the BytePusher VM