Skip to content

Commit 7844fb0

Browse files
authored
📝 Add caveat re: OSX CPU usage
1 parent ab0715c commit 7844fb0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/recommended-usage/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# Recommended usage
2+
This assumes some technical knowledge of Atom and your OS. If you're already using Atom you should be fine though. :)
23

3-
While the plugin can be run in any Atom window it's recommended to run it in a separate instance for easier usage and access to your notes.
4+
While the plugin can be run in any Atom window, it's recommended to run it in a separate instance (e.g. [Atom beta](https://atom.io/beta), or vice versa) to not interfere with your normal developer workflow (open/closing Atom, changing between app windows etc.).
45

5-
The custom init script [.atom/init.coffee](.atom/init.coffee#L10) contains some code to activate this package on startup, and to register a global keyboard shortcut to easily toggle/access the Atom window and this package's search field.
6+
It's also recommended to run this instance using a custom `ATOM_HOME` folder, for windows settings, init script, custom keymappings etc. not to interfere with your default Atom. See the [mac-atom-beta.sh](mac-atom-beta.sh) for an example of how that can be achieved.
67

7-
You may of course copy-paste this to your global Atom init config (typically located at `~/.atom/init.coffee`), but otherwise you can check the the shell script [mac-atom-beta.sh](mac-atom-beta.sh) for an example how to run a separate [Atom beta](https://atom.io/beta) instance (assumed to be installed in the default location), which use a custom atom-home dir to run the custom init script only for this instance.
8+
Here you also can find my [custom init script](.atom/init.coffee#L10), that contains some code to activate this package on startup, and to register a global keyboard shortcut to easily toggle/access that particular instance window from anywhere.
9+
10+
## Caveat: Using MacOSX?
11+
By default the package would have an idle CPU usage of 50%, due to some unresolved issues in lower-level node libraries - While unfortunate it does have an easy solution! Simply make sure that there's no space in the path to the application, most likely it's enough to rename the app to "AtomBeta.app" and re-install this package again. Now the idle CPU usage should be around 0-0.5%.
12+
13+
See [this report](https://github.com/atom/apm/issues/499#issuecomment-254695325) for more technical details.

0 commit comments

Comments
 (0)