README.md
author Jan Vrany <jan.vrany@fit.cvut.cz>
Mon, 16 Sep 2013 16:57:32 +0100
changeset 83 e02330ae1fe4
parent 65 95ece3112f7c
child 250 a27be88be57f
permissions -rw-r--r--
Bugfix in EditService: correctly react on classHolder/methodHolder changes.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     1
# SmallSense
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     2
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     3
*Developer's productivity plugin for Smalltalk/X IDE.*
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     4
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     5
## About 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     6
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     7
**SmallSense** is a set of tools that speed up development and make
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     8
Smalltalk programming even more fun. Features:
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     9
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    10
* **Code-completion** -- a fast code completion system for Smalltalk using both static and runtime type inference. 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    11
* **Syntax-driven editing** -- a nice little feature that helps you with editing and formatting the code, all syntax- and formate-preferences aware! 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    12
* **Instant static analysis** -- to detect & fix common errors and code smells as you type
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    13
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    14
There are many more features already on the TODO list :-) Besides, *SmallSense*
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    15
provides a common infrastructure to implement support for other languages as well.
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    16
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    17
## Installation
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    18
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    19
Just download and compile the package. Then, load the package into running Smalltalk/X IDE: 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    20
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    21
    Smalltalk loadPackage:`jv:smallsense`
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    22
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    23
*Note*: In Smalltalk/X jv-branch, SmallSense is already included so no need to 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    24
download and load.   
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    25
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    26
## Authors
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    27
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    28
Developers:
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    29
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    30
* Jan Vraný <jan . vrany [a] fir.cvut.cz>
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    31
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    32
Contributors:
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    33
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    34
* Jakub Zelenka (first version of code completion, type inference and syntax-error tolerant Smalltalk parser) 
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    35
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    36
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    37
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    38