Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 90 lines (49 sloc) 3.875 kb
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
1 # Soda Theme
2
b8f3d0d @buymeasoda Update readme with Soda Dark details and screenshot
buymeasoda authored
3 Dark and light custom UI themes for Sublime Text 2.
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
4
2c8628d @buymeasoda Move design image to top of readme and update supporting info
buymeasoda authored
5 ## Design
6
50ad40f @buymeasoda Update Soda Dark screenshot
buymeasoda authored
7 ![Soda Light Theme](http://buymeasoda.github.com/soda-theme/images/screenshots/soda-2-light-theme.png?v=3)
2c8628d @buymeasoda Move design image to top of readme and update supporting info
buymeasoda authored
8
50ad40f @buymeasoda Update Soda Dark screenshot
buymeasoda authored
9 ![Soda Dark Theme](http://buymeasoda.github.com/soda-theme/images/screenshots/soda-2-dark-theme.png?v=1)
b8f3d0d @buymeasoda Update readme with Soda Dark details and screenshot
buymeasoda authored
10
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
11 ## Installation
12
005f798 @buymeasoda Update readme. Make details about compatibility with ST2 dev builds more...
buymeasoda authored
13 Soda theme is designed to work with the latest [development build](http://www.sublimetext.com/dev) of Sublime Text 2.
14
20c6884 @buymeasoda Update readme with Sublime Package Control installation instructions
buymeasoda authored
15 ### Using Sublime Package Control
16
17 If you are using Will Bond's excellent [Sublime Package Control](http://wbond.net/sublime_packages/package_control), you can easily install Soda Theme via the `Package Control: Install Package` menu item. The Soda Theme package is listed as `Theme - Soda` in the packages list.
da67cdc @buymeasoda Update installations instructions with git clone instructions
buymeasoda authored
18
19 ### Using Git
20
20c6884 @buymeasoda Update readme with Sublime Package Control installation instructions
buymeasoda authored
21 Alternatively, if you are a git user, you can install the theme and keep up to date by cloning the repo directly into your `Packages` directory in the Sublime Text 2 application settings area.
22
98ee1f8 @buymeasoda Improve installation instructions with details for locating the ST2 pack...
buymeasoda authored
23 You can locate your Sublime Text 2 `Packages` directory by using the menu item `Preferences -> Browse Packages...`.
24
25 While inside the `Packages` directory, clone the theme repository using the command below:
da67cdc @buymeasoda Update installations instructions with git clone instructions
buymeasoda authored
26
27 git clone https://github.com/buymeasoda/soda-theme/ "Theme - Soda"
28
29 ### Download Manually
30
6a9fb99 @buymeasoda Slight adjustment to the installation instructions
buymeasoda authored
31 * Download the files using the GitHub .zip download option
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
32 * Unzip the files and rename the folder to `Theme - Soda`
00474f0 @buymeasoda All: Relocated theme folder from requiring 'Packages/User' to 'Packages'...
buymeasoda authored
33 * Copy the folder to your Sublime Text 2 `Packages` directory
6a9fb99 @buymeasoda Slight adjustment to the installation instructions
buymeasoda authored
34
35 ## Activating the theme
36
37 To configure Sublime Text 2 to use the theme:
38
20c6884 @buymeasoda Update readme with Sublime Package Control installation instructions
buymeasoda authored
39 * Open your User Settings Preferences file `Sublime Text 2 -> Preferences -> Settings - User`
b8f3d0d @buymeasoda Update readme with Soda Dark details and screenshot
buymeasoda authored
40 * Add (or update) your theme entry to be `"theme": "Soda Light.sublime-theme"` or `"theme": "Soda Dark.sublime-theme"`
5d33fc9 @buymeasoda Update readme usage instructions
buymeasoda authored
41
d6eb602 @buymeasoda Update installation instructions for new ST2 settings file in Build 2174...
buymeasoda authored
42 ### Example User Settings
5d33fc9 @buymeasoda Update readme usage instructions
buymeasoda authored
43
44 {
45 "theme": "Soda Light.sublime-theme"
46 }
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
47
6103a3d @buymeasoda Add instructions and screenshot of tab style configuration
buymeasoda authored
48 ## Configurable Features
49
50 ### Alternate Tab Styles
51
52 Soda Theme ships with two alternate UI tab styles.
53
54 By default, a square tab style is used. If you'd prefer to use the original curved tab style, add the following custom setting to your `Settings - User` file:
55
56 "soda_classic_tabs": true
57
58 ![Soda Tab Styles](http://buymeasoda.github.com/soda-theme/images/features/multiple-tab-styles.png)
59
2c8628d @buymeasoda Move design image to top of readme and update supporting info
buymeasoda authored
60 ## Bonus Options
bddf8ee @buymeasoda Move notes about syntax highlighting to below the design information. Ad...
buymeasoda authored
61
e7cf32a @buymeasoda Add details about syntax highlighting schemes used in the screenshots, a...
buymeasoda authored
62 ### Syntax Highlighting Colour Schemes
b8f3d0d @buymeasoda Update readme with Soda Dark details and screenshot
buymeasoda authored
63
e7cf32a @buymeasoda Add details about syntax highlighting schemes used in the screenshots, a...
buymeasoda authored
64 The Soda Light screenshot uses a modified version of Espresso Tutti Colori and the Soda Dark screenshot uses a modified version of Monokai.
556edb6 @buymeasoda Update readme with details about code syntax highlighting colour scheme
buymeasoda authored
65
e7cf32a @buymeasoda Add details about syntax highlighting schemes used in the screenshots, a...
buymeasoda authored
66 If you'd like to use the syntax highlighting schemes shown in the screenshots:
eedcfa5 @buymeasoda Add instructions about installing / referencing the colour scheme
buymeasoda authored
67
e7cf32a @buymeasoda Add details about syntax highlighting schemes used in the screenshots, a...
buymeasoda authored
68 * Download [colour-schemes.zip](http://buymeasoda.github.com/soda-theme/extras/colour-schemes.zip)
69 * Unzip and place the extracted `tmtheme` files in the Sublime Text 2 `Packages/User` folder
70 * Enable the colour scheme via `Preferences -> Color Scheme -> User`
556edb6 @buymeasoda Update readme with details about code syntax highlighting colour scheme
buymeasoda authored
71
2c8628d @buymeasoda Move design image to top of readme and update supporting info
buymeasoda authored
72 ### Code Font
87eb804 @buymeasoda Update readme with additional theme development notes and wiki
buymeasoda authored
73
005f798 @buymeasoda Update readme. Make details about compatibility with ST2 dev builds more...
buymeasoda authored
74 The code font shown in the screenshot is Menlo.
9c008b2 @buymeasoda Update readme with details about theme development and ST2 dev builds
buymeasoda authored
75
76 ## Development
45c1df3 @buymeasoda Adding a readme file with some basic info
buymeasoda authored
77
005f798 @buymeasoda Update readme. Make details about compatibility with ST2 dev builds more...
buymeasoda authored
78 Please note, Sublime Text dev builds move quickly and changes can occur with the theme API between releases, so there may be occasions where the theme doesn't quite work with a brand new dev release.
79
9c008b2 @buymeasoda Update readme with details about theme development and ST2 dev builds
buymeasoda authored
80 While developing the theme, I have documented some [theme challenges and ideas](https://github.com/buymeasoda/soda-theme/wiki/Theme-challenges-and-ideas) encountered along the way.
81
d836a25 @buymeasoda Update README with Creative Commons license and usage details
buymeasoda authored
82 ## License
83
84 Soda Theme is licensed under the [Creative Commons Attribution-ShareAlike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/). You are free to share and remix the theme, however please abide by the license terms when doing so.
85
86 The following details apply to the Creative Commons license "author specified" components:
87
e4b053c @buymeasoda Minor copy corrections
buymeasoda authored
88 * Attribution example: Based on Soda Theme by Ian Hill (http://buymeasoda.com/)
d836a25 @buymeasoda Update README with Creative Commons license and usage details
buymeasoda authored
89
d32d8f5 @buymeasoda Remove license not about Pictos icons which are no longer used
buymeasoda authored
90 * Naming guidelines: If you create and distribute a derivative theme, please give your theme a unique and original name that does not directly include "Soda Theme" (or a close variant) in the main project title, repo name or Package Control name.
Something went wrong with that request. Please try again.