You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+11-3
Original file line number
Diff line number
Diff line change
@@ -11,21 +11,29 @@ All platforms require git, bash, and ssh to be installed and on the system path.
11
11
*Windows*
12
12
* Git must be installed to the default location, this will be made more configurable in future updates.
13
13
* The git/bin directory must be on the system path.
14
+
* If not on the path already, git, bash, and ssh can be put on the path by selecting the "Use Git and optional Unix tools from the Windows Command Prompt" option on the "Adjusting your PATH environment" step of the git installer.
14
15
15
16
*Linux*
16
17
* Xterm must be installed and on the system path. This should be more flexible in future updates.
17
18
18
19
###Package installation
19
-
The recommended way to install SummitEditor is through Package Control. To install via Package Control:
20
+
The recommended way to install SummitEditor is through Package Control. If you do not have Package Control installed, read the [installation instructions](https://sublime.wbond.net/installation). To install via Package Control:
20
21
21
22
1. Bring up the Command Palette (`ctrl+shift+p` or `cmd+shift+p` on Mac) and type `install`. Among the commands you should see `Package Control: Install Package`. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
22
23
2. When the plugin list appears, type `SummitEditor`. Among the entries you should see `SummitEditor`. If that entry is not highlighted, use the keyboard or mouse to select it.
23
24
24
-
Optionally, you can use git to clone this repository into your Sublime Text `Packages` directory. You can confirm that this has worked by opening the Command Palette and typing the word `summit`. You should see an available syntax option for `Lua (Summit)`.
25
+
Optionally, you can use git to clone this repository into your Sublime Text `Packages` directory. You can confirm that installation has worked by opening the Command Palette and typing the word `summit`. You should see an available syntax option for `Lua (Summit)`.
25
26
26
27
###Optional Packages
27
28
SummitEditor also offers a [SummitLinter](https://github.com/corvisacloud/SummitLinter) plugin for [SublimeLinter 3](http://www.sublimelinter.com/en/latest/) allowing for automatic linting of your code. To install SummitLinter (as well as SublimeLinter if it is not already installed), first make sure you meet the [requirements](https://github.com/corvisacloud/SummitLinter#installation), then select `Tools > SummitEditor > Install SummitLinter Packages`. Note: using this option requires Package Control to be installed.
28
29
30
+
###Application Structure
31
+
When you clone your application, the application directory should be as follows:
32
+
\<application\>/
33
+
├── assets
34
+
├── spec
35
+
└── src
36
+
The simulator will run the `main.lua` file inside the application's `src` directory.
29
37
30
38
##Running The Simulator
31
39
@@ -36,7 +44,7 @@ Now that you have a project created, we need to add some simulator settings to i
You can also optionally add the application id, which can be useful for simulation involving data in datastores:
47
+
build_path should point to the `src` directory's parent directory and *not* the `src` directory itself. You can also optionally add the application id, which can be useful for simulation involving data in datastores:
0 commit comments