Skip to content

Commit a1c0bb0

Browse files
committed
Simplify and restructure plugin installation and usage guide, update visuals for clarity.
1 parent 0858525 commit a1c0bb0

3 files changed

Lines changed: 16 additions & 47 deletions

File tree

docs/getting-started.md

Lines changed: 16 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -28,43 +28,41 @@ The plugin manager usually contains stable releases that made it through testing
2828
Steps:
2929

3030
1. Open Settings/Preferences (Windows/Linux: `Ctrl-S`, Mac: `Cmd-,`)
31-
2. On the left, select **Plugins**
32-
3. Click on the button `Browse repositories`
33-
4. In the search field, type `Material Theme`
34-
5. Double-click `Material Theme UI` to install it. You can also decide to install `Atom Material Icons` to get the icons' customization feature.
35-
6. Click the `OK` button and restart the IDE.
36-
37-
<img src="/img/screens/listplugin.png" alt="Plugins List">
31+
2. On the left, select or search for **Plugins**
32+
3. In the search field, type `Material Theme`
33+
4. Install the `Material Theme UI` plugin
34+
5. Click the `OK` button and restart the IDE.
3835

3936
### Manual installation
4037

41-
If, for some reason, you don't want to use the plugin repository, or if you want to run your fork of the plugin, you can
42-
decide to install it manually.
38+
You can also install the plugin manually:
4339

4440
<a href="https://plugins.jetbrains.com/plugin/8006-material-theme-ui">
4541
<button class="btn">Download <icon class="fa fa-download"></icon></button>
4642
</a>
4743

4844
Steps:
4945

50-
1. Select the version you want to install. Please note the _Compatible Builds_ column to ensure that your IDE is compatible with the selected version.
51-
2. Download the zip archive of the plugin.
46+
1. Go to the [plugin page](https://plugins.jetbrains.com/plugin/8006-material-theme-ui)
47+
2. Go to the **Download** section and download the latest version of the plugin as a zip file.
5248
3. Open Plugins settings (`Preferences → Plugins`)
53-
4. Instead of selecting `Browse repositories`, select **Install plugin from disk** and select the zip file.
49+
4. Click on the "more" button and select **Install plugin from disk** and select the zip file.
5450
5. Click OK and restart the IDE.
5551

5652
----
5753

5854
## Usage
5955

60-
Once the plugin is installed, you should immediately notice that the color of your IDE changed to a nice oceanic blue
61-
color!
62-
But the Material Theme Plugin is much more than that.
56+
Congratulations! You've just installed the Material Theme plugin.
57+
58+
If that's your first time using the plugin, you'll get greeted with a nice wizard to help you get started.
59+
60+
{% include figure.html content="/screens/wizard.png" caption="Material Theme Wizard" %}
6361

6462
### Setting the color scheme
6563

6664
The first thing to set is to change the color scheme to fit your current _UI Theme_. It's usually done automatically
67-
when selecting a theme, but if it doesn't for some reason, here's how you do it:
65+
when selecting a theme, but you can also decide to assign a different color scheme.
6866

6967
To do so, open the `Quick Switch Panel` by typing `Ctrl + ``/Cmd + ~` and select `Color Scheme`.
7068
Alongside the color schemes provided by the IDE, and your own custom color schemes, you should find the color schemes provided by the
@@ -94,8 +92,7 @@ plugin:
9492
- {{theme.name}}
9593
{% endfor %}
9694

97-
These schemes are adapted to the UI Theme of the same name, plus, for Atom One Dark, a complete port of the original
98-
[Atom One Dark](https://github.com/atom/one-dark-syntax) color scheme.
95+
These schemes are adapted to the UI Theme of the same name.
9996

10097
You can see more in the [Color Schemes](/docs/configuration/color-schemes) section.
10198

@@ -106,10 +103,6 @@ There you can turn off certain features, change the sizes, appearance of the ele
106103

107104
These settings are found inside `Settings → Appearance and Behavior → Material Theme`.
108105

109-
{% include figure.html content="/screens/settings.png" caption="Material Theme Settings V1" %}
110-
111-
{% include figure.html content="/screens/settingsV2.png" caption="Material Theme Settings V2" %}
112-
113106
Check [Settings](/docs/configuration/settings) for more info.
114107

115108
### Material Theme quick panel
@@ -125,30 +118,6 @@ These action groups are found in:
125118

126119
Check [Actions](/docs/configuration/quick-actions-panel) for more info
127120

128-
## Supported versions
129-
130-
The plugin is supported on all IDEs, but because of changes of the SDK specific versions are available only on the latest builds:
131-
132-
- IDE versions 2016.X and lower > up until version `0.2.3`
133-
- IDE versions 2017.1-2 > up until version `0.10.6`
134-
- IDE versions 2017.3+ > up until version `1.6.0.4`
135-
- IDE versions 2018.1 > from version `1.7.0` up to `2.4.0`
136-
- IDE versions 2018.2 > from version `2.4.0-2018.2` up to `3.1.0`
137-
- IDE versions 2018.3 > from version `3.1.0` up to `3.4.2`
138-
- IDE versions 2019.1 > from version `3.5.0` up to `3.9.3`
139-
- IDE versions 2019.2 > from version `4.0.0` up to `4.4.0`
140-
- IDE versions 2019.2.1 > from version `4.4.0` up to `4.5.1`
141-
- IDE versions 2019.3 > from version `4.6.0` up to `4.11.0`
142-
- IDE versions 2020.1 > from version `4.11.0`
143-
- IDE versions 2020.2 > from version `5.3.0`
144-
- IDE versions 2020.3 > from version `5.6.0` up to `5.7.0`
145-
- IDE versions 2021.1 > from version `6.0.0` up to `6.7.0`
146-
- IDE versions 2021.2 > from version `6.8.0`
147-
- IDE versions 2021.3 > from version `6.11.0`
148-
- IDE versions 2022.1 > from version `7.0.0` up to `7.5.2`
149-
- IDE versions 2022.2 > from version `7.6.0` up to `7.11.0`
150-
- IDE versions 2022.3 > from version `8.0.0`
151-
152121
## Premium Support
153122

154123
From version 6.0.0 the plugin has become a freemium plugin.
@@ -161,4 +130,4 @@ The plugin should be compatible with Android Studio just fine,
161130
but since _Android Studio Bumblebee_ you would need to
162131
install [another plugin](https://plugins.jetbrains.com/plugin/13407-jetbrains-marketplace-licensing-support) to be able to **Activate your license**.
163132

164-
*[freemium]: The plugin is free, but some functionalities are under a paywall.
133+
*[freemium]: The plugin is free, but some functionalities are under a paywall.

img/screens/plugins.png

-282 KB
Loading

img/screens/wizard.png

280 KB
Loading

0 commit comments

Comments
 (0)