Răsfoiți Sursa

add feature listing

Noah 4 ani în urmă
părinte
comite
08ac7caa6e
1 a modificat fișierele cu 16 adăugiri și 3 ștergeri
  1. 16 3
      README.md

+ 16 - 3
README.md

@@ -1,5 +1,4 @@
 # The TI-BASIC Compiler (tibasicc)
-
 The TI-BASIC Compiler is all about compiling TI-BASIC code on your computer into an .8xp file ready for transferring to your TI-83/TI-83+/TI-84 calculator (and vice versa).
 
 Being able to type your programs on a real keyboard instead of the calculator's keypad is much easier and avoids some otherwise big pain.
@@ -7,7 +6,6 @@ Being able to type your programs on a real keyboard instead of the calculator's
 *Note:* This project is a fork from [pcmattman/tibasic](https://sourceforge.net/projects/tibasic/).
 
 ## Installation
-
 I have only tested this on GNU/Linux, but it should work on any other unix-like OS like MacOS:
 
     git clone https://github.com/noahvogt/tibasicc.git
@@ -21,4 +19,19 @@ After installing, this program should be in your `path`. This means, you can cal
 
     tibasicc [options]
 
-I haven't made a man page for this simple program yet, but you can get some usage information when you run this program without any arguments or with some help flags (` -h` or ` --help`).
+I haven't made a man page for this simple program yet, but you can get some usage information when you run this program without any arguments or with some help flags (`-h` or `--help`).
+
+## Features
+Base Features
+- compiling from source to .8xp
+- decompiling from .8xp to source (`-d` flag)
+      
+Preprocessor 
+- support for comments (using `#`)
+- remove empty lines
+- remove lines that only contain whitespaces
+- strip off unneeded whitespaces to make the binary smaller
+
+Additional Options
+- verbose / debug mode that give a lot of information (`-v` flag)
+- specify output file (`-o` flag)