README.md
changeset 394 2877f9bcc95d
parent 320 5242593726f0
--- a/README.md	Sun Feb 08 08:11:01 2015 +0000
+++ b/README.md	Wed Feb 11 22:38:49 2015 +0000
@@ -13,22 +13,54 @@
 
 There are many more features already on the TODO list :-) Besides, *SmallSense*
 provides (limited) support for Java anf Groovy as well (to be used together with
-[STX:LIBJAVA](https://swing.fit.cvut.cz/projects/stx-libjava))
+[STX:LIBJAVA](1))
 
 ## Installation
 
-Just download and compile the package. Then, load the package into running Smalltalk/X IDE:
+### Stock Smalltalk/X (aka official version)
+
+Following instructruction are for stock Smalltalk/X 6.2.5 as downloaded from
+[eXept]. 
+
+**1. Remove old SmallSense:** remove directory `/stx/goodies/smallsense`. Smalltalk/X may come with it's own version/fork of SmallSense. 
+
+**2. Check out SmallSense:** 
+
+    hg clone https://bitbucket.org/janvrany/stx-goodies-smallsense stx/goodies/smallsense
+    
+**3. Compile it (optional):**
+
+On UNIX: 
+
+    make -C /stx/goodies/smallsense -f Makefile.init
+    
+On Windows: 
+
+    cd stx\goodies\smallsense && bmake
+    
+**4. Load it:** to load it into an IDE, evaluate:
 
     Smalltalk loadPackage:'stx:goodies/smallsense'
+    
+You may want to add the above to your startup script (`$HOME/.smalltalk/p_$USER.rc) so SmallSense will be loaded automatically when you start Smalltalk/X. You may also want to turn on [method swizzling](4) there. 
 
-*Note*: In [Smalltalk/X jv-branch](https://swing.fit.cvut.cz/projects/stx-jv), SmallSense is already included so no need to
-download and load.
+### Smalltalk/X jv-branch
+
+There's no need to install SmallSense into [Smalltalk/X jv-branch](3) as it is 
+loaded automatically when you start Smalltalk/X. 
+
+
+## Configuration
+
+After installing and loading SmallSense, you may want to configure it. To do so,
+open system settings and go to *Tools* ⊳ *SmallSense*.
+
 
 ## Authors
 
 Developers:
 
-* Jan Vraný <jan . vrany [a] fir.cvut.cz>
+* Jan Vraný <jan . vrany [a] fit.cvut.cz>
 
 Contributors:
 
@@ -41,9 +73,11 @@
 For other licensing options, please contact the SmallSense author at
 jan.vrany { at } fit.cvut.cz.
 
+[1]: https://swing.fit.cvut.cz/projects/stx-libjava
+[2]: ftp://exept.de/download/stx/
+[3]: https://swing.fit.cvut.cz/projects/stx-jv
+[4]: https://bitbucket.org/janvrany/stx-goodies-smallsense/wiki/Swizzling.md
 
 
 
 
-
-