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

Screw markdown README

Browse Source
This commit is contained in:
Pentium44 2021-04-08 03:07:40 -07:00
parent 4edc8c032f
commit 2745dbb1ce
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md → README.txt
View File

@ -1,18 +1,21 @@
SlideScript ======
=== === SlideScript
A simple, user friendly scripting language. ======
===== A simple, user friendly scripting language for the average person. SS is meant to
be simple, and work as its documented as. SlideScript is a bin tool to say the
least and is a helpful *nix userland tool in the CLI
Using SlideScript -----
Compiling
----- -----
* Compile SS using the make command. * Compile SS using the make command.
* Install SS using make install. * Install SS using make install.
* Modify test.ss to learn the basics of SS. * Modify test.ss to learn the basics of SS.
* Run ./test.ss to execute the script. * Run ./test.ss to execute the script.
***NOTE: if compiling on OSX/BSD, please uncomment #define BSD in src/config.h*** ***NOTE: if compiling on OSX/BSD, please uncomment #define BSD in src/config.h***
-----
Documentation 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
@ -71,6 +74,7 @@ net-listen.ss -> displays slidescript's raw listen socket
net-toss.ss -> displays the 'client side' networking function. net-toss.ss -> displays the 'client side' networking function.
-----
Todo list Todo list
----- -----
@ -82,6 +86,7 @@ This section will obviously expand and adapt to the direction of the language. T
* More networking function flexibility * More networking function flexibility
* File pull / file push functionality * File pull / file push functionality
-----
Done Done
----- -----
@ -97,7 +102,7 @@ List of finished features, in a rough summary.
* Shebang handling * Shebang handling
* Variable support * Variable support
-----
Changelog Changelog
----- -----
@ -138,8 +143,8 @@ by V1.0.0 release! From there it will be molding and preserving the art.
* Added variable handling with a buffer size of 2KB per variable, and cap of 2048 variables. * Added variable handling with a buffer size of 2KB per variable, and cap of 2048 variables.
* Now operates under the shebang! * Now operates under the shebang!
-----
Contributions Contributions
----- -----
Robert (OldCoder) Kiraly -> shebang support and string manipulations Robert (OldCoder) Kiraly -> shebang support and string manipulations
(C) Copyright 2014-2021 Chris Dorman, some rights reserved (GPLv2) (C) Copyright 2014-2021 Chris Dorman, some rights reserved (GPLv2)