From d015213091f12dbe383d7feb6bdb414b8190ac87 Mon Sep 17 00:00:00 2001 From: Arun Murugan Date: Sat, 18 Dec 2021 08:31:23 +0530 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a45026..def1077 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,24 @@ Brainfuck is a minimal esoteric programming language. It provides a 30K 8-bit ar For more checkout this [video made by fireship](https://youtu.be/hdHjjBS4cs8). +## Synopsis +Run without arguments to get the following help message: +```bash +$ bfuk + +bfuk 1.0.0 +Description: a Brainf**k programming language interpreter. +Author: Arun Murugan +Usage: + bfuk [OPTIONS] COMMAND +Example: + bfuk /filepath/filename.bf +Options: + -e string + Execute given string of brainf**k program + +``` + ## Installation ### Binary Download @@ -37,4 +55,4 @@ Checkout the [releases](https://github.com/ArunMurugan78/bfuk/releases/latest) t ``` ## License -This project is licensed under the **MIT** license. \ No newline at end of file +This project is licensed under the **MIT** license.