Skip to content

Commit

Permalink
added Package Control install-message
Browse files Browse the repository at this point in the history
some clearification in the readme
  • Loading branch information
LucaVazz committed May 19, 2016
1 parent 75000a5 commit 325b11f
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ I'm fairly sure you are convinced now ;)
2. Install Package Control in Sublime Text as described [here](https://packagecontrol.io/installation) and restart Sublime Text
3. Open the Command Palette (by pressing <kbd>Ctrl</kbd>/<kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>), select `Package Control: Install Package`, wait for the list to load and select `SetlX Helper` from the list
4. After the installation is done (the progress is shown in the lower left corner) you are all set. Just open a SetlX-program file and enjoy the new help!
5. *optional* I recommend using the *Monokai Extended* Color Scheme for a nice and colorful syntax-highlighting.



Expand All @@ -22,7 +23,6 @@ I'm fairly sure you are convinced now ;)
Just type code ;)
![Illustration of the Syntax Definitions](screenshots/readme_syntax.PNG)
*Keep in mind: The colors don't come from the Helper-Plugin. You can choose them as you like by selecting a Color Scheme you like from the* Preferences *Menu of Sublime Text.*
I recommend using the *Monokai Extended* Color Scheme.


#### Quickly Open the [Quickreference](https://github.com/LucaVazz/SetlXQuickreference/blob/master/SetlX-Quickreference.pdf)
Expand All @@ -48,8 +48,8 @@ After that, you can just press <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>B</kbd> to st
## Features to Come Soon / ToDo
| Version | Feature | optional Description |
|---------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 0.4.0 | [+] build-system - error-parsing | get the parsed errors directly pinned to the troubled position in your program |
| 0.5.0 | real-time basic mistake warning | marks common (dumb) mistakes (like forgetting a semicolon/a closing bracket, using commas in a vector-definition, etc.) with a warning in real-time in your file as you type |
| 2.0.0 | [+] build-system - error-parsing | parse all errors from the interpreter's output and get them directly "pinned" to the troubled position in your program |
| 3.0.0 | real-time basic mistake warning | marks common (dumb) mistakes (like forgetting a semicolon/a closing bracket, using commas in a vector-definition, etc.) with a warning in real-time in your file as you type |


*Feel free to suggest additional features by using GitHub-Issues.*
Expand Down
3 changes: 3 additions & 0 deletions messages.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"install": "messages/install.txt"
}
29 changes: 29 additions & 0 deletions messages/install.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Thanks for installing the SetlX-Helper for Sublime Text. I'm sure you will enjoy working with it.


To get you started, here are some tips on how to use its features:
-> Syntax Definitions
Just type code and enjoy the highlighting.
Keep in mind:
The colors don't come from the Helper-Plugin. You can choose them as you like by selecting a Color Scheme you like from the "Preferences" Menu of Sublime Text.
I recommend using the "Monokai Extended" Color Scheme for a nice and colorful syntax-highlighting (available via PAckage Control).

-> Quickly Open the Quickreference
Open the Command Palette and select "SetlX Helper: Open the SetlX-Quickreference".
A new browser-window will open to display the Quickreference.

-> Type Common Structures Faster With Snippets
To insert a snippet, just enter its keyword (which is its name, if not noted otherwise below) and press [Enter] to insert it.
You can then jump through the placeholders by pressing [Tab] (and insert a real tab by pressing [Shift]+[Tab]).
Available snippets:
definition of a set / list / closure / procedure / cached procedure
if -/else if -/else -/ match -/ switch - statements
for -/ while - loops
try-catch - (keyword: catch) / trace - blocks
case -/ default - statements.

-> Build System
(For now) you need to install SetlX as described in its manual. This means that you should be able to type "setlx" into a console-window and get the live interpreter fired up.
Make sure that "SetlX" is selected as "Build System" in the "Tools"-Menu when writing and testing a SetlX-Program.

After that, you can just press [Ctrl]/[Cmd]+[B] to start your SetlX-program and view its results inside Sublime Text own console (at the bottom of your window).

0 comments on commit 325b11f

Please sign in to comment.