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.creole
+2-112
Original file line number
Diff line number
Diff line change
@@ -9,118 +9,8 @@ The plugin uses a channel and repository system to allow users to find new
9
9
packages over time without any work. It also supports working with packages that
10
10
were manually installed.
11
11
12
-
== Installation
13
-
14
-
=== Via Console
15
-
16
-
The simplest installation is through the Sublime Text 2 console. This is
17
-
accessed via the ctrl+` shortcut. Once open, paste the following command
18
-
into the console:
19
-
20
-
{{{
21
-
import urllib2,os;pf='Package Control.sublime-package';ipp=sublime.installed_packages_path();os.makedirs(ipp) if not os.path.exists(ipp) else None;open(os.path.join(ipp,pf),'wb').write(urllib2.urlopen('http://sublime.wbond.net/'+pf.replace(' ','%20')).read())
22
-
}}}
23
-
24
-
This command creates the //Installed Packages// directory for you, and then
25
-
downloads the {{{Package Control.sublime-package}}} into it.
26
-
27
-
Finally, restart Sublime Text 2.
28
-
29
-
=== Manually
30
-
31
-
Download http://sublime.wbond.net/Package%20Control.sublime-package and copy it
32
-
to your //Installed Packages// directory. This can be found by going to the
33
-
//Preferences// menu and selecting //Browse Packages…//, then browsing up a
34
-
folder. If you do not see a folder named //Installed Packages// on the same
35
-
level as //Packages//, you’ll need to create it.
36
-
37
-
After the {{{.sublime-package}}} file is in //Installed Packages//,
38
-
restart Sublime Text 2.
39
-
40
-
== Usage
41
-
42
-
Package Control is driven by the //Command Pallete//. To open the pallete,
43
-
press ctrl+shift+p (Windows, Linux) or cmd+shift+p (OS X). All Package Control
44
-
commands begin with {{{Package Control: }}}, so start by typing {{{Package}}}.
45
-
46
-
The command pallete will now show a number of commands:
47
-
48
-
* Add Repository
49
-
* Add Repository Channel
50
-
* Create Package File
51
-
* Create Binary Package File
52
-
* Disable Package
53
-
* Discover Packages
54
-
* Enable Package
55
-
* Install Package
56
-
* List Packages
57
-
* Remove Package
58
-
* Upgrade Package
59
-
* Package Control Settings – Default
60
-
* Package Control Settings – User
61
-
62
-
Well skip the concept of Repositories and Channels for now and dive into
63
-
discovering and installing your first package!
64
-
65
-
To learn about plugins, run the //Discover Packages// command. A list of all
66
-
available packages will be presented. Selecting a package will open its
67
-
homepage in your browser.
68
-
69
-
Once you have found a package you wish to install, run the //Install Package//
70
-
command. A quick-panel (like Goto Anything) will appear listing all available
71
-
packages. Select a package and Package Control will download the package file
72
-
and install the package into the running instance of Sublime Text 2.
73
-
74
-
Once a package is installed is can be removed or upgraded via the command
75
-
pallete.
76
-
77
-
By default Package Control checks for new versions on startup. This setting,
78
-
plus the list of channels and repositories are managed through the settings.
79
-
Settings can be opened via the command pallete, or the //Preferences > Package
80
-
Settings > Package Control > Settings – User// menu entry.
81
-
82
-
=== Channels and Repositories
83
-
84
-
Channels are JSON files hosted on a URL that contains a list of
85
-
repository URLs. See {{{example-repositories.json}}} for the format. When a user
86
-
requests to install a package, their channels are queried for a list of
87
-
repositories.
88
-
89
-
Repositories as JSON files hosted on a URL that contain a list of packages.
90
-
See {{{example-packages.json}}} for the format. The custom format allows
91
-
specifying platforms (windows, osx, linux) for packages and provides a
92
-
description and version.
93
-
94
-
In addition to supporting a custom JSON format for repositories, Package
95
-
Control supports GitHub and BitBucket URLs:
96
-
97
-
* https://github.com/user/repo
98
-
* https://github.com/organization_or_user
99
-
* https://bitbucket.org/user/repo
100
-
101
-
With these URLs, no work is necessary by the package developer to support
102
-
Package Control. Package Control parses JSON from the GitHub and BitBucket
103
-
APIs and uses their zip download functionality to fetch the package.
104
-
105
-
There is an option {{{package_name_map}}} in the settings to allow for
106
-
mapping repository names to package names. For instance, the {{{sode-theme}}}
107
-
repository on GitHub needs to be installed as {{{Theme - Soda}}} to function
108
-
properly. Channels may also specify name mapping.
109
-
110
-
Package Control comes with a single default channel installed. If you would
111
-
like one or more of your repositories added to the default channel, please fork
112
-
https://github.com/wbond/package_control_channel on GitHub or
113
-
https://bitbucket.org/wbond/package_control_channel on BitBucket
114
-
and send a pull request. You can also email me at [email protected].
115
-
116
-
=== Creating a Package File
117
-
118
-
If you are developing a package, Package Control includes a command to
119
-
create a {{{.sublime-package}}} file for you from one of your package
120
-
directories. Just run the //Create Package// command and you can select what
121
-
package you would like to package up. The packager exlcudes various VCS
122
-
metadata, Sublime Text 2 cache files and {{{.pyc}}} files by default. The list
123
-
of excluded files can be tweaking through the settings.
12
+
Please see http://wbond.net/sublime_packages/package_control for install
0 commit comments