Pentium44/slidescript
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md being dumb

Browse Source
This commit is contained in:
Pentium44 2021-04-07 18:03:17 -07:00
parent 951d4aeb79
commit eb623d49fd
1 changed files with 64 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
README.md
View File

@ -15,96 +15,94 @@ Documentation
Here is a list of functions and features that SlideScript comes with Here is a list of functions and features that SlideScript comes with
at this moment! at this moment!
* Commenting! Examples: * Commenting! Examples:
* `# Comment is real in this one` * `# Comment is real in this one`
* Read and writing to flat files. Examples: * Read and writing to flat files. Examples:
* `write "file.txt" "This will be written to file.txt"` * `write "file.txt" "This will be written to file.txt"`
* `read "file.txt"` * `read "file.txt"`
* Delete example: * Delete example:
* `delete "file.txt"` * `delete "file.txt"`
* Execute example: * Execute example:
* `exec "ls -al"` * `exec "ls -al"`
* Print example: * Print example:
* `print "Hi everyone!"` * `print "Hi everyone!"`
* Sleep (Zzz) example (sleeps for 2 seconds): * Sleep (Zzz) example (sleeps for 2 seconds):
* `sleep 2` * `sleep 2`
* Variable setting and passing * Variable setting and passing
* `filename=file.txt` -> filename * `filename=file.txt` -> filename
* `filedata=File '%filename%' is being moved to moo` -> %filename% is populated as file.txt * `filedata=File '%filename%' is being moved to moo` -> %filename% is populated as file.txt
* `write "%filename%" "%filedata%"` -> writes filedata contents to file.txt as expected. * `write "%filename%" "%filedata%"` -> writes filedata contents to file.txt as expected.
* Decoding and encoding strings * Decoding and encoding strings
* `encrypt "Regular string"` -> Converts to encrypted string 'Uhjvqds#xuulqj' * `encrypt "Regular string"` -> Converts to encrypted string 'Uhjvqds#xuulqj'
* `decrypt "Uhjvqds#xuulqj"` -> Converts back to 'Regular string' * `decrypt "Uhjvqds#xuulqj"` -> Converts back to 'Regular string'
* MD5 file checking * MD5 file checking
* `md5 "file.txt"` -> outputs filename and md5 hash * `md5 "file.txt"` -> outputs filename and md5 hash
* 2 Layer piping * 2 Layer piping
* `md5 "file.txt" | write "file.txt.md5" "%PIPE%"` -> writes output of md5 to file.txt.md5 * `md5 "file.txt" | write "file.txt.md5" "%PIPE%"` -> writes output of md5 to file.txt.md5
* Networking functions * Networking functions
* `netlisten "<port>" "<search>" "<respond>"` -> listens on <port> and replies <respond> on <search> found from outside * `netlisten "<port>" "<search>" "<respond>"` -> listens on <port> and replies <respond> on <search> found from outside
* `nettoss "<address>" "<port>" "<data>"` -> binds to outside server at <address>:<port> and pushes <data> thus, disconnecting * `nettoss "<address>" "<port>" "<data>"` -> binds to outside server at <address>:<port> and pushes <data> thus, disconnecting
* `nethttp "<port>" "<forkval>"` -> throws up a web server on <port> in the current working directory, forkval (0 or 1, 0 don't fork into background / 1 do). * `nethttp "<port>" "<forkval>"` -> throws up a web server on <port> in the current working directory, forkval (0 or 1, 0 don't fork into background / 1 do).
This will change rapidly as of currently, slidescript is in beavy development! This will change rapidly as of currently, slidescript is in beavy development!
Todo list Todo list
------ ------
* Add in-script functions * Add in-script functions
* New static functions * New static functions
* Loops, and if statements * Loops, and if statements
Done Done
------ ------
* Simple syntax checking and error reporting * Simple syntax checking and error reporting
* 2 layer function piping * 2 layer function piping
* Support for linux system calls * Support for linux system calls
* Network listen socket, toss function * Network listen socket, toss function
* Builtin HTTP server for disposeable use, can be ran in the foreground or forked into the background * Builtin HTTP server for disposeable use, can be ran in the foreground or forked into the background
* Read and write from file * Read and write from file
* Some simple functions * Some simple functions
* Shebang handling * Shebang handling
* Variable support * Variable support
Changelog Changelog
----- -----
* V0.3.3 * V0.3.3
* Added first networking functions: netlisten, nettoss, nethttp. * Added first networking functions: netlisten, nettoss, nethttp.
* Embedded web server functionality * Embedded web server functionality
* Cleaned up code * Cleaned up code
* Improved syntax handling on functions * Improved syntax handling on functions
* V0.3.0
* Added simple 2 layer function piping for more useful tasks
* Fixed a couple core dump bugs
* Now reads files into memory, and then forces text files through SS, allows for in file variables
* Added "md5" functionality
* Multi-formal working syntax
* V0.2.1
* Added "decrypt" decode function
* Added "encrypt" encode function
* Added system "exec" function
* Added basic syntax handling, for a more uniform language
* V0.3.0 * V0.2.0
* Added simple 2 layer function piping for more useful tasks * Added "delete" function
* Fixed a couple core dump bugs * Added embedded variable handling to SS functions (variables can be used like everywhere!)
* Now reads files into memory, and then forces text files through SS, allows for in file variables * Added linux system calls via exec
* Added "md5" functionality * Some cleaning up.
* Multi-formal working syntax
* V0.2.1 * V0.1.1
* Added "decrypt" decode function * Added variable handling with a buffer size of 2KB per variable, and cap of 2048 variables.
* Added "encrypt" encode function * Now operates under the shebang!
* Added system "exec" function
* Added basic syntax handling, for a more uniform language
* V0.2.0
* Added "delete" function
* Added embedded variable handling to SS functions (variables can be used like everywhere!)
* Added linux system calls via exec
* Some cleaning up.
* V0.1.1
* Added variable handling with a buffer size of 2KB per variable, and cap of 2048 variables.
* Now operates under the shebang!
Contributions Contributions
----- -----