Add Troubleshooting.md and a short note in README.md
#141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This document covers known issues and gives hints what to do when La Capitaine works not as expected.
I added a short note that the file `Troubleshooting.md` *might* be useful.
keeferrourke
requested changes
May 1, 2017
README.md
Outdated
| @@ -45,6 45,9 @@ the size of this project to a minimum. | |||
| You'll need to run the configuration script to tell La Capitaine to update its | |||
| directory structure to use the dark variant. | |||
|
|
|||
| ### Troubleshooting | |||
| If something does not work as expected with La Capitaine, take a look at the file `Troubleshooting.md`. There you'll find the most common traps, their solution and known issues. It may not be your fault. | |||
There was a problem hiding this comment.
hyperlink Troubleshooting.md
Troubleshooting.md
Outdated
| @@ -0,0 1,33 @@ | |||
| # Troubleshooting | |||
| If you have problems with the La Capitaine Icon Theme, please read the following sections before submitting an issue on GitHub. `.desktop` files usually can be found in `/usr/share/applications/` (accessible for all users) or in `~/.local/share/applications/` (accessible for the current user). To see if some application icon is available in La Capitaine, just browse `apps/scalable/` in this repository and have a look. If you got lucky, the icon can be applied to any application by placing `Icon=cool-icon-name` in the application's `.desktop` file, assuming `apps/scalable/cool-icon-name.svg` exists. | |||
There was a problem hiding this comment.
rather than cool-icon-name, it would be better to use programmer jargon, such as foo-icon-name
Troubleshooting.md
Outdated
|
|
||
| ## No icon gets themed | ||
| ### Your environment is not supported | ||
| This could be due to your desktop environment or system not being supported. Some older environments, mostly ugly ones :wink:, are not supporting SVG icons. The solution is rasterizing the vector graphics, which is not planned for now. See [the Wiki section for supported environments](https://github.com/keeferrourke/la-capitaine-icon-theme/wiki#supported-environments) for more information. |
There was a problem hiding this comment.
I would remove the comment about ugly desktops. Everyone has different ideas of aesthetic, and it's unfair to cast windowmaker and dwm aside as ugly. #allDesktopsMatter 😉
Troubleshooting.md
Outdated
| First of all make sure, that you have copied the `la-capitaine-icon-theme` (name doesn't matter) folder into either `/usr/share/applications/` or `~/.local/share/applications/`, as described in the first paragraph of this document. | ||
| It now should be selectable in your system Theme settings or a tweak tool for your desktop. If not, try closing and re-opening the application you use for theming. | ||
|
|
||
| If that doesn't work either, double-check if the incon theme folder was copied properly and into the correct folder. For the system-wide one, you might need root previleges. If you have multiple users on the machine, look if you chose the home directory of the user currently logged in (for a local install). |
Troubleshooting.md
Outdated
|
|
||
| ## Some Icons are unthemed | ||
| ### The missing icon is not (yet) included | ||
| This is indeed very common, since La Capitaine is far away from being complete. However, the diversity of Linux distributions is tricky here, since most of them give each distribution-specific application its own name. And there are a lot of them out there... |
There was a problem hiding this comment.
This paragraph is probably unnecessary.
| ------------ | ------------- | ------------- | ||
| Nemo | `Icon=folder` | `Icon=nemo` | ||
| Gcolor2 | `Icon=/usr/share/pixmaps/gcolor2/gcolor2.xpm` | `Icon=gcolor2` | ||
| PyCharm | `Icon=/opt/pycharm-xxx/bin/pyCharm.png` | `Icon=pycharm` |
There was a problem hiding this comment.
Pretty sure most intelliJ IDEs are affected by this problem.
Fixed all problems mentioned here: #141
|
Okay, done. Hope it's fine now :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started writing a troubleshooting guide including a list of applications with hardcoded icon paths 😠. The list only contains four items by now, but can be extended from time to time, to cover all the special applications.
I also added some other notes, but don't take it as "the complete guide to troubleshoot La Capitaine". Just a beginning for new La Capitaine users.