The goal is to create a Stable set of packages which can work together, leading your Sublime Text to be able to program/develop any language you ever need to.
Either its Stable or its Development version have been Stable for some time. Anyone interested in using it, can just follow the installation instructions at the Installation section.
Any interested in contributing, can just do so by creating a new issue with your new ideias or issues. You can check the issue tracker for a list of issues to be worked on. Note, there are some issues I already fixed, just forgot to close them yet.
- The table of contents used on this Markdown was generated by:
git clone https://github.com/evandroforks/markdown-toccd markdown-tocnpm -g installcd ../repository-rootmarkdown-toc README.MD
Installation Go to Top
When following the installation steps, you are going to be prompted to install either the Stable or Development version. If you are planning to fix bugs and contribute to Sublime Text plugins Development, you should choose the Development installation. But, if you are only looking to use things and report bugs, you can choose the Stable installation.
- Download & Install
Sublime Text 3(https://www.sublimetext.com/3) - Go to the menu
Tools -> Install Package Control, then, wait few seconds until the installation finishes up - Now,
Go to the menu
Preferences -> Package Control - Type
Add Channelon the opened quick panel and press Enter - Then,
input the following address and press Enter
https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json - Go to the menu
Tools -> Command Palette... (Ctrl+Shift+P) - Type
Preferences: Package Control Settings – Useron the opened quick panel and press Enter - Then,
find the following setting on your
Package Control.sublime-settingsfile:"channels": [ "https://packagecontrol.io/channel_v3.json", "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json", ],
- And,
change it to the following, i.e.,
put the
https://raw.githubusercontent...line as first:"channels": [ "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json", "https://packagecontrol.io/channel_v3.json", ],
- The
https://raw.githubusercontent...line must to be added before thehttps://packagecontrol.io...one, otherwise, you will not install this forked version of the package, but the original available on the Package Control default channelhttps://packagecontrol.io...
- The
- Now,
go to the menu
Preferences -> Package Control - Type
Install Packageon the opened quick panel and press Enter - Then,
search for
StudioChanneland press Enter - After finished installing the
StudioChannelpackage, just follow the instructions on the screen. - You can also see this old video tutorial How to the Install Sublime Studio.
Stable Installation Go to Top
If you chose the Stable Installation, on this section you are going to be introduced with Stable installation tips.
While installing the Stable version, you can quickly edit any installed packages files by:
- Opening the command palette and
running the command
PackageResourceViewer: Extract All Packages. - And setting the PackagesManager setting
"extract_everything": true
Using the Sublime Project Go to Top
You can also open the SublimeStudio.sublime-project inside the Packages/StudioChannel package (git submodule) to quickly view/edit all installed
packages.
Just note,
if you are using the Stable version and
as all packages are distributed unpacked on the Stable version,
all of your changes to the installed packages are going to be lost when they upgrade.
If you would like to save them after the upgrade,
you can use the OverrideUnpackedPackages feature.
See:
OverrideUnpackedPackages for more information.
Adding to git Go to Top
You can create a git repository on the root of your Stable Sublime Text installation by using the following .gitignore file:
/.sublime/
/Backup/
/Cache/
/Index/
/KEEPME
/Local/
/Settings/
/Packages/User/FileHistory*.json
/Packages/User/PackagesManager.cache/*
**/.git/**
*.sublime-packageThis should exclude most undesired/binary things and allow you to fiercely control which changes happens with your Sublime Text Stable installation of the ITE.
Development Installation Go to Top
If you chose the Development Installation, on this section you are going to be introduced with Development instructions/tips.
If you installed the Development version, you need to have installed on your system path variable the following programs:
gitcurl(linux/cygwin)wget(linux/cygwin)zip(linux/cygwin)unzip(linux/cygwin)date(linux/cygwin)
Beyond your local git client,
it is recommended to install some git client interface as SmartGit,
in order to manage this project because it has very complex submodules management.
Also,
your local git client need to have the user/login and
password cached because some commands used by some packages like the Channel Manager,
directly/unattended perform git operations like git pull and git push. Then,
if your username or
password is not cached,
these packages commands which do git operations,
are going to hang/block/not work properly.
To cache your git password you can use tools like:
- https://github.com/Microsoft/Git-Credential-Manager-for-Windows
- https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage
git clone Go to Top
It is not advised to use the git --clone command because git is buggy and
cannot handle to clone this repository correctly.
By following the installation instructions just above,
you are going to be prompted whether you would like to install the Stable version or
the Development version.
And choosing the Development,
this repository is going to programmatically and
correctly be cloned by a Python Script.
So,
there is not need to directly use the git clone command.
But,
if you feel like manually using the git clone command,
you need to pass the --recursive option and
use it like this:
git clone --recursive -j4 https://github.com/evandrocoan/ITE
The -j4 parameter is to parallelly clone the repository using up to 4 threads or
CPU cores.
Sublimehq/Packages Go to Top
Even if you choose to install the Development version, by the automated installer, it will not install the default upstream for Sublimehq/Packages. For it, you can just run these commands:
git clone --recursive https://github.com/evandroforks/Packages
mv Packages/.git "$SUBLIME_TEXT_DATA/Packages/.git"Then,
you will need to open the directory $SUBLIME_TEXT_DATA/Packages as a usual git repository,
which is completely disconnected from the main ITE repository.
Disabled Packages Go to Top
For an updated list of packages to not enable see the issue:
- #50 Ignored packages to not enable!
Debugging Go to Top
Use on the console: (View -> Show Console)
sublime.log_input(True); sublime.log_commands(True); sublime.log_result_regex(True); sublime.log_indexing(True);
To disable it do:
sublime.log_input(False); sublime.log_commands(False); sublime.log_result_regex(False); sublime.log_indexing(False);
License Go to Top
All files in this repository are released under GNU General Public License v3.0 or
the latest version available on http://www.gnu.org/licenses/gpl.html,
except the files coming from git submodules (see .gitmodules file) and
the files/directories which include their own license header/file.
Sublime Studio, A set of Settings and Packages for Sublime Text 3
Copyright (C) 2018 Evandro Coan <https://github.com/evandrocoan>
Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
Neither the name Evandro Coan nor the names of any
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
For more information see:
- The LICENSE file for the GPL v3.0 license
- The website https://www.gnu.org/licenses/gpl-3.0.en.html
All the other files within each git submodule have its own license specified, except until 19/09/2017,
where the following linked packages as git submodules by the file .gitmodules,
does not include an explicit license from their original author: