README.md
author Claus Gittinger <cg@exept.de>
Fri, 18 Nov 2016 11:56:15 +0100
branchcvs_MAIN
changeset 996 f5c13fa1943d
parent 320 5242593726f0
child 394 2877f9bcc95d
permissions -rw-r--r--
#OTHER by cg documentation
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
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
     5
## About
65
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
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    10
* **Code-completion** -- a fast code completion system for Smalltalk using both static and runtime type inference.
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    11
* **Syntax-driven editing** -- a nice little feature that helps you with editing and formatting the code, all syntax- and formater-preferences aware!
65
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*
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    15
provides (limited) support for Java anf Groovy as well (to be used together with
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    16
[STX:LIBJAVA](https://swing.fit.cvut.cz/projects/stx-libjava))
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    17
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    18
## Installation
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    19
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    20
Just download and compile the package. Then, load the package into running Smalltalk/X IDE:
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    21
250
a27be88be57f Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 65
diff changeset
    22
    Smalltalk loadPackage:'stx:goodies/smallsense'
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    23
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    24
*Note*: In [Smalltalk/X jv-branch](https://swing.fit.cvut.cz/projects/stx-jv), SmallSense is already included so no need to
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    25
download and load.
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    26
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    27
## Authors
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    28
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    29
Developers:
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    30
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    31
* Jan Vraný <jan . vrany [a] fir.cvut.cz>
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    32
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    33
Contributors:
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    34
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    35
* Jakub Zelenka (first version of code completion, type inference and syntax-error tolerant Smalltalk parser)
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    36
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    37
## License
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    38
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    39
The SmallSense is available under GNU Lesser General Public License.
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    40
Please find full text of the license in file license.txt.
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    41
For other licensing options, please contact the SmallSense author at
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    42
jan.vrany { at } fit.cvut.cz.
65
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    43
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    44
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    45
95ece3112f7c Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    46
252
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    47
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    48
feba6ee5c814 Added copyright notice and license information (LGPL2)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 250
diff changeset
    49