improve docs

rnayabed · Jan 25, 2025 · 739580a · 739580a
1 parent 913f2f7
commit 739580a
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/docs/display.md b/docs/display.md
@@ -23,15 +23,32 @@ Finally, we load these changes to our display buffer
 
 I have included a simple companion program that can generate program to print something on the display. 
 
+### Usage
+
+```
+usage: shilpi [-h] [-v] [-o OUTPUT] [-t] [input]
+
+Simple pixel drawer from the Sutra-1 System
+
+positional arguments:
+  input                Input text or file
+
+options:
+  -h, --help           show this help message and exit
+  -v, --version        Version and copyright information
+  -o, --output OUTPUT
+  -t, --text
+```
+
 ### Text mode
 
 ```shell
-python shilpi.py -t 'namaste world'
+python shilpi.py -t "namaste world"
 ```
 
 This generates an output assembly file with the name `display-image.S` which can then be compiled by rochoyita
 
-```
+```shell
 python rochoyita.py display-image.S
 ```
 

diff --git a/docs/rochoyita.md b/docs/rochoyita.md
@@ -19,6 +19,23 @@ Rochoyita is a rudimentary assembler written for Sutra-1.
 - Raw mode which disables pre processor. It is automatically enabled when `.s` file is encountered on non Windows Systems or `--raw` is explicitly passed in arguments.
 - [Pseudo instructions](https://github.com/rnayabed/sutra-1/blob/master/docs/ISA.md#Pseudo_Instructions)
 
+## Usage
+
+```
+usage: rochoyita [-h] [-v] [-o OUTPUT] [-r] [input]
+
+Simple assembler from the Sutra-1 System
+
+positional arguments:
+  input                Input assembly source file
+
+options:
+  -h, --help           show this help message and exit
+  -v, --version        Version and copyright information
+  -o, --output OUTPUT  Output Logisim Evolution memory image file
+  -r, --raw            Disable preprocessor
+```
+
 ## High-level flowchart
 
 ```mermaid

diff --git a/rochoyita.py b/rochoyita.py
@@ -25,7 +25,7 @@
 DISABLE_PREPROCESSOR = args.raw
 
 if args.version:
-    print(f'''rochoyita Version {VERSION}
+    print(f'''rochoyita version {VERSION}
 Copyright (C) 2025 Debayan Sutradhar
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

diff --git a/shilpi.py b/shilpi.py
@@ -462,7 +462,7 @@ def generate_art_from_text(text):
 args = parser.parse_args()
 
 if args.version:
-    print(f'''shilpi Version {VERSION}
+    print(f'''shilpi version {VERSION}
 Copyright (C) 2025 Debayan Sutradhar
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.