[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[sc-dev] SF.net SVN: supercollider: [7378] trunk/build/Help/ Extending and Customizing SC/Quarks/Quarks.html



Revision: 7378
          http://svn.sourceforge.net/supercollider/?rev=7378&view=rev
Author:   cruxxial
Date:     2008-02-23 11:31:34 -0800 (Sat, 23 Feb 2008)

Log Message:
-----------
much improved Quarks help file

Modified Paths:
--------------
    trunk/build/Help/Extending and Customizing SC/Quarks/Quarks.html

Modified: trunk/build/Help/Extending and Customizing SC/Quarks/Quarks.html
===================================================================
--- trunk/build/Help/Extending and Customizing SC/Quarks/Quarks.html	2008-02-23 15:45:38 UTC (rev 7377)
+++ trunk/build/Help/Extending and Customizing SC/Quarks/Quarks.html	2008-02-23 19:31:34 UTC (rev 7378)
@@ -11,165 +11,213 @@
 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
-p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
-p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #a8220e}
-p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #0c2dac}
-p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #7c301a}
-p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
-p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 13.0px Helvetica}
-p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.0px Verdana}
-p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
-p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #000000}
-p.p14 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #606060}
-span.s1 {text-decoration: underline}
-span.s2 {color: #0013bb}
-span.s3 {color: #000000}
-span.s4 {color: #0c2dac}
-span.s5 {color: #606060}
-span.s6 {font: 9.0px Monaco}
-span.s7 {font: 12.0px Helvetica}
-span.s8 {font: 11.0px Verdana}
+p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
+p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ff}
+p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.0px Verdana; min-height: 13.0px}
+p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
+p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
+p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #0000bf}
+p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #952e14; min-height: 12.0px}
+p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #70351d; min-height: 12.0px}
+p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #70351d}
+p.p14 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #1230a8}
+p.p15 {margin: 0.0px 0.0px 0.0px 0.0px; font: 13.0px Helvetica}
+p.p16 {margin: 0.0px 0.0px 0.0px 0.0px; font: 13.0px Helvetica; min-height: 16.0px}
+p.p17 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.0px Verdana}
+p.p18 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #606060}
+span.s1 {color: #0929ae}
+span.s2 {color: #000000}
+span.s3 {font: 11.0px Verdana}
+span.s4 {color: #0000bf}
+span.s5 {text-decoration: underline}
+span.s6 {color: #001bb7}
+span.s7 {color: #1230a8}
+span.s8 {color: #606060}
+span.s9 {font: 9.0px Monaco}
+span.s10 {font: 12.0px Helvetica}
+span.s11 {color: #0000ff}
 span.Apple-tab-span {white-space:pre}
 </style>
 </head>
 <body>
 <p class="p1"><b>Quarks</b></p>
 <p class="p2"><br></p>
-<p class="p3">A Quark is a package of SC classes, helpfiles, C++ source for UGens and/or other SC code.</p>
-<p class="p3">The packages are stored in a Subversion (SVN) repository and downloaded/updated automatically.</p>
-<p class="p2"><br></p>
-<p class="p3">You will need the <b>subversion</b> client software installed ( <span class="s1">http://subversion.tigris.org</span> ). To check whether you already have it, type "svn help" in a terminal window.</p>
+<p class="p3">SC supports extensions to its class library, documentation, and server UGen plugins. <span class="Apple-converted-space">  </span>Extensions are folders containing all three, or any combination that are in:</p>
 <p class="p4"><br></p>
+<p class="p5"><span class="s1">Platform</span>.userExtensionDir</p>
 <p class="p4"><br></p>
-<p class="p5"><b>Recommended typical usage</b></p>
+<p class="p3">A Quark is a more formalized kind of extension folder that can be shared with others and can be easily installed or uninstalled using the Quarks package manager.</p>
 <p class="p4"><br></p>
-<p class="p3">First make sure your Quarks directory is up-to-date:</p>
+<p class="p6"><span class="s2">See also: <a href="../Using-Extensions.html">Using-Extensions</a></span></p>
 <p class="p4"><br></p>
-<p class="p6"><span class="s2">Quarks</span><span class="s3">.checkoutDirectory </span>// Do this if it's your first time</p>
-<p class="p6"><span class="s2">Quarks</span><span class="s3">.updateDirectory <span class="Apple-converted-space">  </span></span>// Otherwise do this</p>
+<p class="p3">So a Quark is a package of SC classes, helpfiles, C++ source for UGens and/or other SC code.</p>
 <p class="p4"><br></p>
-<p class="p3">On Mac, those commands will launch in a terminal window. If the update process asks you whether to accept an SSL certificate, press 'p' to accept it permanently.</p>
+<p class="p3">There is a shared library of these packages on SourceForge.net (<span class="s3">https://quarks.svn.sourceforge.net/svnroot/quarks) </span>offering a variety of useful extra capabilities for SC.</p>
+<p class="p7"><br></p>
 <p class="p4"><br></p>
-<p class="p3">Then either launch the GUI to manage which Quarks you want to install...</p>
 <p class="p4"><br></p>
-<p class="p7">Quarks<span class="s3">.gui</span></p>
+<p class="p3">There are two standard ways to obtain this shared Quarks library.</p>
 <p class="p4"><br></p>
-<p class="p3">...or use the "install" command directly:</p>
+<p class="p8"><b>Downloaded binary</b></p>
 <p class="p4"><br></p>
-<p class="p8"><span class="s4">Quarks</span><span class="s3">.install(</span><span class="s5">"testquark"</span><span class="s3">); </span>// This will DOWNLOAD and install as needed, inc dependencies</p>
+<p class="p3">If you have downloaded the full binary of SC then you already have them in the Optional Extras folder of the SC download.</p>
+<p class="p3">If so, move the 'quarks' folder into this directory:</p>
 <p class="p4"><br></p>
-<p class="p3">After a quark is installed you must <b>recompile the language</b> so that it's aware of the new extensions. Then you can use it:</p>
+<p class="p9">// execute this code to post the directory path</p>
+<p class="p5"><span class="s4">Platform</span>.userAppSupportDir</p>
 <p class="p4"><br></p>
-<p class="p9"><span class="s4">TestQuark</span>.sayHello</p>
+<p class="p3">(note: do not place it inside Extensions. If you place all of them inside extensions, then they will all be in the compile path. )</p>
 <p class="p4"><br></p>
-<p class="p3">You can of course uninstall quarks if you decide you don't need them:</p>
-<p class="p2"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.uninstall(<span class="s5">"testquark"</span>);</p>
+<p class="p3">The Quarks package manager will now be able to install and uninstall individual Quark packages.<span class="Apple-converted-space">  </span>It does so by making a symlink in the Extensions/quarks folder pointing back to the quark's source code which stays in the User App Support directory.</p>
 <p class="p4"><br></p>
 <p class="p4"><br></p>
-<p class="p10"><b>Check out all available Quarks</b></p>
-<p class="p4"><span class="Apple-converted-space"> </span></p>
-<p class="p9"><span class="s4">Quarks</span>.checkoutAll</p>
+<p class="p5">(</p>
+<p class="p9">// manage Quarks packages from a gui</p>
+<p class="p10">Quarks.gui</span></p>
+<p class="p5">)</p>
+<p class="p4"><br></p>
+<p class="p3">(note: do not turn everything on.<span class="Apple-converted-space">  </span>start slowly)</p>
+<p class="p4"><br></p>
+<p class="p3">Some Quarks depend on other Quarks and will automatically install the other ones they need. <span class="Apple-converted-space"> </span></p>
+<p class="p4"><br></p>
+<p class="p3"><b>Conflicts of classes and package dependencies are always a possibility, so be aware that you may "break" your SC so that it cannot compile what has been placed in its compile path. <span class="Apple-converted-space"> </span></b></p>
+<p class="p4"><br></p>
+<p class="p3">If this happens, simply open this folder:</p>
+<p class="p3">Platform.userExtensionDir</p>
+<p class="p4"><br></p>
+<p class="p3">and delete the symlinks inside the quarks folder.<span class="Apple-converted-space">  </span>(Remember: these symlinks point back to the actual quarks sitting harmlessly in your app support directory)</p>
+<p class="p4"><br></p>
+<p class="p4"><br></p>
+<p class="p8"><b>Getting Quarks from the SVN repository</b></p>
+<p class="p4"><br></p>
+<p class="p3">The other way to obtain the Quarks library is to checkout a copy using Subversion (SVN).<span class="Apple-converted-space">  </span>SC is fully integrated with SVN and can checkout single quarks or update them whenever developers make changes.<span class="Apple-converted-space">  </span>This is a wonderful thing since you can complain about a broken knob, somebody in Belgium will fix it and a few hours later its working for you.</p>
+<p class="p4"><br></p>
+<p class="p3">You will need the <b>subversion</b> client software installed ( <span class="s5">http://subversion.tigris.org</span> ). To check whether you already have it, type "svn help" in a terminal window.</p>
+<p class="p4"><br></p>
+<p class="p3"><b>If you have previously installed the quarks library from the binary download, you should move or delete that folder now.</b></p>
+<p class="p4"><br></p>
+<p class="p3">The Quarks class and the quarks gui manager will be executing subversion commands.</p>
+<p class="p4"><br></p>
+<p class="p3">On Mac, those commands will launch in a terminal window. The first time you run a SourceForge quarks svn command you will be asked whether to accept the SSL certificate for SourceForge.<span class="Apple-converted-space">  </span>Press 'p' to accept it permanently.</p>
+<p class="p4"><br></p>
+<p class="p4"><br></p>
+<p class="p8"><b>The DIRECTORY</b></p>
+<p class="p4"><br></p>
+<p class="p3">The quarks folder contains a folder called DIRECTORY filled with quarkfiles xxxxxxxxy.quark</p>
+<p class="p3">These file describe the quark, the developer and note any dependencies.<span class="Apple-converted-space">  </span>You can update the directory without downloading all of the quarks.</p>
+<p class="p4"><br></p>
+<p class="p3">If you have not yet checked the directory out :</p>
+<p class="p4"><br></p>
+<p class="p5"><span class="s6">Quarks</span>.checkoutDirectory</p>
 <p class="p2"><br></p>
-<p class="p3">This downloads them into {Application Support Directory}/quarks but does not yet install them into your class library.</p>
+<p class="p3">Thereafter you can simply update it:</p>
+<p class="p11"><br></p>
+<p class="p5"><span class="s6">Quarks</span>.updateDirectory</p>
 <p class="p4"><br></p>
-<p class="p3">It can be particularly helpful because you won't in future need to have an internet connection to install the quarks: they are already downloaded even if not installed.</p>
+<p class="p12"><br></p>
+<p class="p13">// list all quarks in the repository</p>
+<p class="p5"><span class="s7">Quarks</span>.repos.quarks</p>
 <p class="p2"><br></p>
-<p class="p8">// post those checked out</p>
-<p class="p9"><span class="s4">Quarks</span>.checkedOut</p>
+<p class="p4"><br></p>
+<p class="p8"><b>Checking out and Installing a Quark</b></p>
+<p class="p4"><br></p>
+<p class="p3">Either launch the package manager to install/uninstall individual Quarks:</p>
+<p class="p4"><br></p>
+<p class="p14">Quarks.gui</span></p>
+<p class="p4"><br></p>
+<p class="p3">which we hope is somewhat self explanatory.<span class="Apple-converted-space">  </span>(and steadily improving)</p>
+<p class="p4"><br></p>
+<p class="p3">...or use the "checkout" command directly:</p>
+<p class="p4"><br></p>
+<p class="p9">// checks it out from svn</p>
+<p class="p5"><span class="s4">Quarks</span>.checkout(<span class="s8">"testquark"</span>);</p>
 <p class="p2"><br></p>
-<p class="p8">// post those checked out with a description</p>
-<p class="p9"><span class="s4">Quarks</span>.listCheckedOut</p>
-<p class="p2"><br></p>
-<p class="p2"><br></p>
-<p class="p10"><b>Checking out a single Quark</b></p>
-<p class="p2"><br></p>
-<p class="p3">If you have never checked out any part of the Quarks repository, you must first check out the directory.</p>
-<p class="p2"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.checkoutDirectory</p>
-<p class="p2"><br></p>
-<p class="p3">Otherwise, you may simply update the existing directory to check for new or changed Quarks.</p>
-<p class="p2"><br></p>
-<p class="p8">// this updates {Application Support}/quarks/DIRECTORY</p>
-<p class="p9"><span class="s4">Quarks</span>.updateDirectory</p>
-<p class="p2"><br></p>
-<p class="p3">That folder contains simple quark files with information like name, path, summary, author etc. for each quark in the repos.</p>
-<p class="p3">Those files are also human-readable.</p>
-<p class="p2"><br></p>
-<p class="p8">// list all quarks in the repository</p>
-<p class="p9"><span class="s4">Quarks</span>.repos.quarks</p>
-<p class="p2"><br></p>
-<p class="p8">// checkout the specific one that you want</p>
-<p class="p9"><span class="s4">Quarks</span>.checkout( <span class="s5">"testquark"</span> )</p>
-<p class="p2"><br></p>
-<p class="p2"><br></p>
-<p class="p2"><br></p>
-<p class="p10"><b>Install</b></p>
-<p class="p2"><br></p>
-<p class="p3">This symlinks the quark's sourcecode folder into your Extensions directory.<span class="Apple-converted-space">  </span>The source code itself stays in the quarks folder, but the symlink is in your Extensions directory, so when you recompile the class library, the quark will be included.</p>
+<p class="p9">// the installs it</p>
+<p class="p5"><span class="s4">Quarks</span>.install(<span class="s8">"testquark"</span>);</p>
 <p class="p4"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.install( <span class="s5">"testquark"</span> )</p>
+<p class="p3">This symlinks the quark's sourcecode folder into your Extensions directory.<span class="Apple-converted-space">  </span>The source code itself stays in the quarks folder, but the symlink is in your Extensions directory (and thus in SC's compile path).</p>
 <p class="p4"><br></p>
-<p class="p3">Recompile your SC library...</p>
+<p class="p3">After a quark is installed you must <b>recompile the language</b>. Installing simply places the code into SC's compile path.<span class="Apple-converted-space">  </span>You must then recompile.</p>
+<p class="p4"><br></p>
+<p class="p3">Then you can use it:</p>
+<p class="p4"><br></p>
+<p class="p5"><span class="s7">TestQuark</span>.sayHello</p>
+<p class="p4"><br></p>
+<p class="p15"><b>Uninstall</b></p>
+<p class="p4"><br></p>
+<p class="p3">You can of course uninstall quarks if you decide you don't need them:</p>
 <p class="p2"><br></p>
-<p class="p8">// test it</p>
-<p class="p9"><span class="s4">TestQuark</span>.sayHello</p>
+<p class="p5"><span class="s7">Quarks</span>.uninstall(<span class="s8">"testquark"</span>);</p>
+<p class="p4"><br></p>
 <p class="p2"><br></p>
+<p class="p13">// list those installed</p>
+<p class="p5"><span class="s7">Quarks</span>.installed</p>
 <p class="p2"><br></p>
-<p class="p8">// list those installed</p>
-<p class="p9"><span class="s4">Quarks</span>.installed</p>
+<p class="p3"><b>Dependencies</b></p>
 <p class="p2"><br></p>
-<p class="p3">Note: Quarks may specify other quarks that they are dependent on.<span class="Apple-converted-space">  </span>Quarks.install will also attempt to install those other quarks that the desired quark depends upon, if not already installed. You can prevent this if neccessary by passing <span class="s6">false</span> as the second argument to Quarks.install.</p>
+<p class="p3">Note: Quarks may specify other quarks that they are dependent on.<span class="Apple-converted-space">  </span>Quarks.install will also attempt to install those other quarks that the desired quark depends upon, if not already installed. You can prevent this if neccessary by passing <span class="s9">false</span> as the second argument to Quarks.install.</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.install( <span class="s5">"somequark"</span>, includeDependencies: <span class="s4">false</span> )</p>
+<p class="p5"><span class="s7">Quarks</span>.install( <span class="s8">"somequark"</span>, includeDependencies: <span class="s7">false</span> )</p>
 <p class="p2"><br></p>
 <p class="p3">Similarly the install command will attempt to <b>download</b> quarks if you don't already have them locally. You can prevent this using the allowCheckout argument:</p>
 <p class="p4"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.install( <span class="s5">"somequark"</span>, checkoutIfNeeded: <span class="s4">false</span> )</p>
+<p class="p5"><span class="s7">Quarks</span>.install( <span class="s8">"somequark"</span>, checkoutIfNeeded: <span class="s7">false</span> )</p>
 <p class="p4"><br></p>
 <p class="p4"><br></p>
-<p class="p10"><b>Uninstall</b></p>
+<p class="p16"><br></p>
 <p class="p2"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.uninstall( <span class="s5">"testquark"</span> )</p>
+<p class="p13">// list those in the repository that you could checkout</p>
+<p class="p5"><span class="s7">Quarks</span>.repos.quarks</p>
 <p class="p2"><br></p>
+<p class="p13">// list those that you have checked out and could now install</p>
+<p class="p5"><span class="s7">Quarks</span>.local.quarks</p>
 <p class="p2"><br></p>
 <p class="p2"><br></p>
-<p class="p8">// list those installed</p>
-<p class="p9"><span class="s4">Quarks</span>.installed</p>
+<p class="p4"><br></p>
+<p class="p15"><b>Check out all available Quarks</b></p>
+<p class="p4"><span class="Apple-converted-space"> </span></p>
+<p class="p5"><span class="s7">Quarks</span>.checkoutAll</p>
 <p class="p2"><br></p>
-<p class="p8">// list those in the repository that you could checkout</p>
-<p class="p9"><span class="s4">Quarks</span>.repos.quarks</p>
+<p class="p3">This downloads all of them into {Application Support Directory}/quarks but does not yet install them into your class library.</p>
+<p class="p4"><br></p>
+<p class="p3">It can be particularly helpful because you won't in future need to have an internet connection to install the quarks: they are already downloaded even if not installed.</p>
 <p class="p2"><br></p>
-<p class="p8">// list those that you have checked out and could now install</p>
-<p class="p9"><span class="s4">Quarks</span>.local.quarks</p>
+<p class="p13">// post those checked out</p>
+<p class="p5"><span class="s7">Quarks</span>.checkedOut</p>
 <p class="p2"><br></p>
+<p class="p13">// post those checked out with a description</p>
+<p class="p5"><span class="s7">Quarks</span>.listCheckedOut</p>
 <p class="p2"><br></p>
-<p class="p10"><b>Other</b></p>
 <p class="p2"><br></p>
+<p class="p2"><br></p>
+<p class="p15"><b>Standard SVN tools</b></p>
+<p class="p2"><br></p>
 <p class="p3">The Quarks class interface mirrors the familar svn commands while substituting in the correct paths.</p>
 <p class="p4"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.update( <span class="s5">"testquark"</span> )</p>
-<p class="p8"><span class="s4">Quarks</span><span class="s3">.update </span>// updates all</p>
+<p class="p5"><span class="s7">Quarks</span>.update( <span class="s8">"testquark"</span> )</p>
+<p class="p13"><span class="s7">Quarks</span>.update // updates all</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="s4">Quarks</span>.status( <span class="s5">"testquark"</span> )</p>
-<p class="p8"><span class="s4">Quarks</span><span class="s3">.status </span>// status of all</p>
+<p class="p5"><span class="s7">Quarks</span>.status( <span class="s8">"testquark"</span> )</p>
+<p class="p13"><span class="s7">Quarks</span>.status // status of all</p>
 <p class="p4"><br></p>
 <p class="p3">You may also use any standard SVN tools which is probably easier especially for add and commit.</p>
 <p class="p4"><br></p>
 <p class="p3">The principal repository is located at:</p>
 <p class="p4"><br></p>
-<p class="p11">https://quarks.svn.sourceforge.net/svnroot/quarks</p>
+<p class="p17">https://quarks.svn.sourceforge.net/svnroot/quarks</p>
 <p class="p4"><br></p>
 <p class="p2"><br></p>
-<p class="p10"><b>Creating a Quark</b></p>
+<p class="p15"><b>Creating a Quark</b></p>
 <p class="p2"><br></p>
-<p class="p11"><span class="s7">Create your folder in </span>{Application Support}/quarks/<span class="Apple-converted-space"> </span></p>
+<p class="p3">Adding a Quark requires using standard SVN tools (command line or SVNX)</p>
+<p class="p2"><br></p>
+<p class="p17"><span class="s10">Create your folder in </span>{Application Support}/quarks/<span class="Apple-converted-space"> </span></p>
 <p class="p3">(we'll assume it's called <i>quarkname</i>)</p>
 <p class="p4"><br></p>
 <p class="p3">Place your classes in this folder.</p>
 <p class="p4"><br></p>
-<p class="p3">Place a quark file called <i>quarkname</i>.quark into <span class="s8">{Application Support}/quarks/DIRECTORY</span></p>
-<p class="p3">(see [<b>Quark</b>] for the format)</p>
+<p class="p3">Place a quark file called <i>quarkname</i>.quark into <span class="s3">{Application Support}/quarks/DIRECTORY</span></p>
+<p class="p3">(see [<a href="Quark.html"><span class="s11"><b>Quark</b></span></a>] for the format)</p>
 <p class="p4"><br></p>
 <p class="p3">You can now install, re-compile, test and uninstall install the quark from your local system without having added it into the public repository.</p>
 <p class="p4"><br></p>
@@ -179,24 +227,24 @@
 <p class="p4"><br></p>
 <p class="p3">You will need a (free) SourceForge account to publish a quark to the subversion repository. You will<span class="Apple-converted-space">  </span>need to be familiar with the basics of svn. <span class="Apple-converted-space"> </span></p>
 <p class="p4"><br></p>
-<p class="p3">You also need the account to be added to the "quarks" project - contact one of the admins listed at <span class="s1">http://sourceforge.net/projects/quarks</span> to do that.<span class="Apple-converted-space"> </span></p>
+<p class="p3">You also need the account to be added to the "quarks" project - contact one of the admins listed at <span class="s5">http://sourceforge.net/projects/quarks</span> to do that.<span class="Apple-converted-space"> </span></p>
 <p class="p4"><br></p>
-<p class="p3">Once you're authorised, here's what to do:</p>
+<p class="p3">Once you're authorised:</p>
 <p class="p4"><br></p>
-<p class="p3">In a shell like Terminal go to <span class="s8">{Application Support}/quarks/<span class="Apple-converted-space"> </span></span> and<span class="Apple-converted-space">  </span>execute :</p>
+<p class="p3">In a shell go to <span class="s3">{Application Support}/quarks/<span class="Apple-converted-space"> </span></span> and<span class="Apple-converted-space">  </span>execute :</p>
 <p class="p4"><br></p>
-<p class="p12">svn add quarkname</p>
+<p class="p5">svn add quarkname</p>
 <p class="p4"><br></p>
-<p class="p12">svn add DIRECTORY/quarkname.quark</p>
+<p class="p5">svn add DIRECTORY/quarkname.quark</p>
 <p class="p2"><br></p>
-<p class="p12">svn commit -m "adding quarkname" quarkname</p>
-<p class="p9">svn commit -m "adding directory entry for quarkname" DIRECTORY/quarkname.quark</p>
+<p class="p5">svn commit -m "adding quarkname" quarkname</p>
+<p class="p5">svn commit -m "adding directory entry for quarkname" DIRECTORY/quarkname.quark</p>
 <p class="p2"><br></p>
-<p class="p13">Be careful to commit only changes to your own quark and to the directory entry you have added.</p>
+<p class="p3"><b>Be careful to commit only changes to your own quark and to the directory entry you have added.</b></p>
 <p class="p2"><br></p>
 <p class="p2"><br></p>
 <p class="p2"><br></p>
-<p class="p5"><b><span class="s1">Local Repository Example</span></b></p>
+<p class="p8"><b><span class="s5">Local Repository Example</span></b></p>
 <p class="p2"><br></p>
 <p class="p3">Besides the public repos at sourceforge you can use any other subversion host including a repository running on your local machine.<span class="Apple-converted-space">  </span>This is useful in that you get version control and an easy way to manage package installation.</p>
 <p class="p4"><br></p>
@@ -206,55 +254,55 @@
 <p class="p3">1.<span class="Apple-tab-span">	</span>Create a directory in svn-repos (e.g. quarks-&lt;yourname/id/institution&gt;).</p>
 <p class="p3"><i><span class="Apple-tab-span">	</span>!This name has to be unique to all Quark repositories you will ever check out!</i></p>
 <p class="p4"><br></p>
-<p class="p3"><span class="Apple-tab-span">	</span>Create a dir within it called <span class="s6">"DIRECTORY"</span> containing quark files.</p>
+<p class="p3"><span class="Apple-tab-span">	</span>Create a dir within it called <span class="s9">"DIRECTORY"</span> containing quark files.</p>
 <p class="p4"><br></p>
 <p class="p3">2.<span class="Apple-tab-span">	</span>Fill repos with your work<span class="Apple-converted-space"> </span></p>
 <p class="p4"><span class="Apple-tab-span">	</span></p>
 <p class="p3">3.<span class="Apple-tab-span">	</span>Now use Quarks to make it accessible in SC (shown at hand of the existing and<span class="Apple-converted-space"> </span></p>
 <p class="p3"><span class="Apple-tab-span">	</span>publicly available SonEnvir quarks):</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir = <span class="s4">Quarks</span>(</p>
-<p class="p14"><span class="s3"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>reposPath: </span>"https://svn.sonenvir.at/repos/SonEnvir/trunk/src/quarks-sonenvir";<span class="s3">,<span class="Apple-converted-space"> </span></span></p>
-<p class="p9"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>localPath: <span class="s4">Platform</span>.userAppSupportDir ++ <span class="s5">"/quarks-sonenvir"</span></p>
-<p class="p9"><span class="Apple-tab-span">	</span>);</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir = <span class="s7">Quarks</span>(</p>
+<p class="p18"><span class="s2"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>reposPath: </span>"https://svn.sonenvir.at/repos/SonEnvir/trunk/src/quarks-sonenvir";<span class="s2">,<span class="Apple-converted-space"> </span></span></p>
+<p class="p5"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>localPath: <span class="s7">Platform</span>.userAppSupportDir ++ <span class="s8">"/quarks-sonenvir"</span></p>
+<p class="p5"><span class="Apple-tab-span">	</span>);</p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.checkoutAll;</p>
-<p class="p8"><span class="s3"><span class="Apple-tab-span">	</span></span>// or, if alreadily checked out at the appropriate place:</p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.update;</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.checkoutAll;</p>
+<p class="p13"><span class="s2"><span class="Apple-tab-span">	</span></span>// or, if alreadily checked out at the appropriate place:</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.update;</p>
 <p class="p2"><br></p>
 <p class="p3">4.<span class="Apple-tab-span">	</span>now install your quarks:</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.listCheckedOut;</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.listCheckedOut;</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.install(<span class="s5">"sonenvir-testquark"</span>);</p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.isInstalled(<span class="s5">"sonenvir-testquark"</span>);</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.install(<span class="s8">"sonenvir-testquark"</span>);</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.isInstalled(<span class="s8">"sonenvir-testquark"</span>);</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.listInstalled</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.listInstalled</p>
 <p class="p2"><br></p>
 <p class="p3">5.<span class="Apple-tab-span">	</span>recompile</p>
 <p class="p3">6.<span class="Apple-tab-span">	</span>test</p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p7"><span class="s3"><span class="Apple-tab-span">	</span></span>SonEnvirTestQuark<span class="s3">.sayHello</span></p>
+<p class="p14"><span class="s2"><span class="Apple-tab-span">	</span></span>SonEnvirTestQuark<span class="s2">.sayHello</span></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir = <span class="s4">Quarks</span>(</p>
-<p class="p14"><span class="s3"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>reposPath: </span>"https://svn.sonenvir.at/repos/SonEnvir/trunk/src/quarks-sonenvir";<span class="s3">,<span class="Apple-converted-space"> </span></span></p>
-<p class="p9"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>localPath: <span class="s4">Platform</span>.userAppSupportDir ++ <span class="s5">"/quarks-sonenvir"</span></p>
-<p class="p9"><span class="Apple-tab-span">	</span>);</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir = <span class="s7">Quarks</span>(</p>
+<p class="p18"><span class="s2"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>reposPath: </span>"https://svn.sonenvir.at/repos/SonEnvir/trunk/src/quarks-sonenvir";<span class="s2">,<span class="Apple-converted-space"> </span></span></p>
+<p class="p5"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>localPath: <span class="s7">Platform</span>.userAppSupportDir ++ <span class="s8">"/quarks-sonenvir"</span></p>
+<p class="p5"><span class="Apple-tab-span">	</span>);</p>
 <p class="p2"><br></p>
-<p class="p9">[...]</p>
+<p class="p5">[...]</p>
 <p class="p2"><span class="Apple-converted-space"> </span></p>
 <p class="p3">N.<span class="Apple-tab-span">	</span>remove what you're don't need</p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.uninstall(<span class="s5">"sonenvir-testquark"</span>)</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.uninstall(<span class="s8">"sonenvir-testquark"</span>)</p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p8"><span class="s3"><span class="Apple-tab-span">	</span></span>// recompile</p>
-<p class="p7"><span class="s3"><span class="Apple-tab-span">	</span></span>SonEnvirTestQuark<span class="s3">.sayHello</span></p>
-<p class="p8"><span class="s3"><span class="Apple-tab-span">	</span></span>// -&gt; error</p>
+<p class="p13"><span class="s2"><span class="Apple-tab-span">	</span></span>// recompile</p>
+<p class="p14"><span class="s2"><span class="Apple-tab-span">	</span></span>SonEnvirTestQuark<span class="s2">.sayHello</span></p>
+<p class="p13"><span class="s2"><span class="Apple-tab-span">	</span></span>// -&gt; error</p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
 <p class="p3">M.<span class="Apple-tab-span">	</span>update</p>
 <p class="p2"><br></p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.updateDirectory</p>
-<p class="p9"><span class="Apple-tab-span">	</span>~qSonEnvir.update</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.updateDirectory</p>
+<p class="p5"><span class="Apple-tab-span">	</span>~qSonEnvir.update</p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.