diff --git a/snowblocks/jetbrains/README.md b/snowblocks/jetbrains/README.md new file mode 100644 index 0000000..af6d018 --- /dev/null +++ b/snowblocks/jetbrains/README.md @@ -0,0 +1,64 @@ +# JetBrains IDEs + +This snowblock provides all important configurations for all used [JetBrains][] IDEs and products, currently [IntelliJ][] (Ultimate Edition), [PyCharm][] (Community Edition), [Webstorm][] and [GoLand][]. For details about the paths for user configurations see the documentation about [directories used by the IDE to store settings, caches, plugins and logs][intellij-doc-settings-paths]. + +## Content + +The includes configurations are mostly platform and IDE/product independent. + +* The [code style][intellij-doc-code-style] XMl configuration file stored in the `codestyles` folder. +* The [inspections][intellij-doc-inspections] XMl configuration file stored in the `inspections` folder. +* The [keymaps][intellij-doc-keymap] XMl configuration files for Linux and macOS stored in the `keymaps` folder. See the [keymap reference][intellij-doc-keymap-ref] for a visual presentation of the default mappings. +* The [preference][intellij-doc-prefs] XMl configuration files are stored in the `options` folder: + * `code.style.schemes.xml` - settings of the currently used code style. + * `colors.scheme.xml` - settings of the currently used color scheme. + * `customization.xml` and `project.default.xml` - settings of the customized [menus and toolbars][intellij-doc-menu-toolbar]. + * `editor.codeinsight.xml` - settings of various automatic code transformations. + * `keymap.xml` - the currently used keymap. + * `laf.xml` and `ui.lnf.yml` - settings of the currently used UI theme. + * all other customized preferences defined in the various categories: `editor.xml`, `ide.general.xml` and `options.xml` +* The list of [disabled plugins][intellij-doc-plugins] stored in the `disabled_plugins.txt` file. + +## Configurations + +### Typeface + +Due to licensing and the availability of specific font families on different operating systems the preferences for the sans-serif UI typefaces must be configured manually using the IntelliJ UI (_Preferences_ → _Appearance & Behavior_ → _Appearance_ → _UI Options_) or by adding the following `