Skip to content

Commit e87a5f7

Browse files
committed
Prepare an user friendly readme
1 parent a35d479 commit e87a5f7

File tree

1 file changed

+56
-4
lines changed

1 file changed

+56
-4
lines changed

README.md

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,67 @@ JetBrains' IDEA/PhpStorm/PyCharm/DataGrip/… theme inspired by the GitHub synta
44

55
Tested with:
66

7-
* PHP
8-
* Python
97
* Bash
10-
* INI
11-
* JavaScript
128
* CSS
9+
* Go
1310
* HTML
11+
* INI
12+
* JavaScript
13+
* JSON
14+
* PHP
15+
* Python
1416
* XML
1517

18+
## How to install
19+
20+
> Shameless rip-off from [this document](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs).
21+
22+
1. Copy [GitHub 3.icls](GitHub%203.icls) to your preferences directory:
23+
24+
#### Windows Vista, 7, 8, 10:
25+
26+
```
27+
<SYSTEM DRIVE>\Users\<USER ACCOUNT NAME>\.<PRODUCT><VERSION>\colors
28+
```
29+
30+
#### Windows XP:
31+
32+
```
33+
<SYSTEM DRIVE>\Documents and Settings\<USER ACCOUNT NAME>\.<PRODUCT><VERSION>\colors
34+
```
35+
36+
#### Linux and other Unix systems
37+
38+
Product directory starting with dot can be found in your user home directory, the pattern is:
39+
40+
```
41+
~/.<PRODUCT><VERSION>/colors
42+
```
43+
44+
#### macOS
45+
46+
```
47+
~/Library/Preferences/<PRODUCT><VERSION>/colors
48+
```
49+
50+
#### `PRODUCT` values
51+
52+
* `IntelliJIdea` (IntelliJ IDEA Ultimate Edition)
53+
* `IdeaIC` (IntelliJ IDEA Community Edition)
54+
* `RubyMine`
55+
* `WebIde` (PhpStorm versions before 2016.1 and WebStorm before 7.0 use this common directory)
56+
* `PhpStorm` (PhpStorm starting from 2016.1 version)
57+
* `WebStorm` (WebStorm starting from 7.0 version)
58+
* `PyCharm`
59+
* `AppCode`
60+
* `CLion`
61+
* `DataGrip`
62+
* `AndroidStudio`
63+
64+
2. Restart your product.
65+
66+
3. Go to Preferences, choose Editor > Color Scheme and select `GitHub 3`.
67+
1668
## Screenshots
1769
1870
![PHP in PhpStorm](Screenshot%20-%20PhpStorm.png)

0 commit comments

Comments
 (0)