Update README.md
This commit is contained in:
parent
c0571d2961
commit
f80379c2ec
1 changed files with 44 additions and 1 deletions
45
README.md
45
README.md
|
|
@ -1,2 +1,45 @@
|
||||||
# tiny
|
# Tiny
|
||||||
|
|
||||||
|
A tiny command line interpreter for organizing, you can split huge single line commands into lines and even add comments and variables!
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Multi-command: You can make multiple commands in same `.tmk` file by having a line that starts with `\n` (all written in this line after the `\n.` will be ignored)
|
||||||
|
|
||||||
|
Comments: You can use comments in the file to your peers or future you remember what you done, also useful to separate sections of a command
|
||||||
|
|
||||||
|
Variables: If a line starts with `%` it will get all the name of it until hit the second `%` and to set variables the line has to start with `set`
|
||||||
|
|
||||||
|
## example
|
||||||
|
|
||||||
|
```
|
||||||
|
;set variables
|
||||||
|
set flags=-Os
|
||||||
|
;compiler
|
||||||
|
g++
|
||||||
|
%flags%
|
||||||
|
|
||||||
|
;files
|
||||||
|
main.cpp
|
||||||
|
|
||||||
|
;includes
|
||||||
|
-lstdc++
|
||||||
|
;output
|
||||||
|
-o tiny.exe
|
||||||
|
```
|
||||||
|
|
||||||
|
# WARNING, THIS PROGRAM HAS STRICT SYNTAX AND IS YET TO IMPROVE
|
||||||
|
## The line MUST to have `;`,`set` and `%` as first character to be detected as comment, setter and variable, so you can have it in the command (without being interpreted by Tiny) by adding a space before.
|
||||||
|
|
||||||
|
|
||||||
|
# Roadmap
|
||||||
|
|
||||||
|
- Add variables when loading a Tiny script
|
||||||
|
|
||||||
|
- Create functions
|
||||||
|
|
||||||
|
- Stuff people ask for
|
||||||
|
|
||||||
|
# Compatibility
|
||||||
|
|
||||||
|
This is supposed to run anywhere, if it dont work in a platform please warn me (maybe exotic systems with uncommon headers like master system or whatever might not work out of the box... idk.. if it even has a CLI lol)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue