Help: Clarify purpose of Quarks#*addFolder

supercollider · Oct 4, 2016 · 03f1c51 · 03f1c51
1 parent f5d8917
commit 03f1c51
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/HelpSource/Classes/Quarks.schelp b/HelpSource/Classes/Quarks.schelp
@@ -48,6 +48,7 @@ ARGUMENT:: path
 In addition to the default downloaded-quarks
 add folders that contain quarks to offer on the menu for installation.
 These may be private quarks, cloned working copies or folders where you have manually downloaded quarks.
+NOTE:: The argument should be a path to a directory emphasis::containing quark directories::. It should emphasis::not:: be an isolated quark directory by itself. Users are discouraged from scattering quark directories in isolated locations. ::
 returns:: this
 
 METHOD:: all

diff --git a/HelpSource/Guides/UsingQuarks.schelp b/HelpSource/Guides/UsingQuarks.schelp
@@ -62,6 +62,8 @@ Quarks.addFolder("~/supercollider/quarks");
 
 Now each quark inside that folder will appear on the GUI for you to un/install.
 
+If you wish to be able to uninstall local quarks, but still see them in the GUI, it is highly recommended to collect your local quark directories under a single master directory. Then, use link::Classes/Quarks#*addFolder:: to add the master directory. code::addFolder:: does not add individual quark directories.
+
 subsection::Recompile the class library
 
 After installing or uninstalling you need to strong::Language > Recompile Class Library::