MPS-27804 - change incorrect dependencies to "Extends"
[mps/mps.git] / readme.txt
1 JETBRAINS MPS $version$ README FILE
2
3 Thank you for downloading JetBrains MPS!
4
5 CONTENTS
6     _CodeSignature/     configuration directory for Mac OS X (in Mac Os X distributions only)
7         bin/                startup files
8         help/               help files
9         languages/          packaged languages
10         lib/                libraries
11         license/            license files
12         MacOS/              configuration directory for Mac OS X (in Mac Os X distributions only)
13         plugin/             JetBrains MPS plugin for IntelliJ IDEA
14         plugins/            plugins for JetBrains MPS
15         Resources/          configuration directory for Mac OS X (in Mac Os X distributions only)
16         about.txt           software included in JetBrains MPS
17         build.number        information about current build
18         build.properties    properties of current build
19         Info.plist          configuration file for Mac OS X (in Mac Os X distributions only)
20         mps.bat             bat-file for starting JetBrains MPS on Windows (may not be present for some distributions)
21         mps.sh              sh-file for starting JetBrains MPS on Unix (may not be present for some distributions)
22         readme.txt          this file
23         releaseNotes.txt    JetBrains MPS $version$ release notes
24         samples.zip         sample projects (see at http://confluence.jetbrains.com/display/MPSD20181/Fast+Track+to+MPS)
25
26 SYSTEM REQUIREMENTS
27     To run JetBrains MPS you need JDK 8.0.
28
29 HOW TO START
30     1. Unpack the JetBrains MPS distribution file to whenever you wish to install the program.
31        We will refer to this destination location as your {installation home} below.
32     2. a) [WINDOWS] Open console window and start mps.bat file, located in {installation home}/bin.
33     2. b) [MAC OS X] Execute JetBrains MPS application.
34     2. c) [UNIX] Open console window and start mps.sh file, located in {installation home}/bin.
35     3. [OPTIONAL] Add the "{installation home}/bin" to your PATH environmental
36        variable so that you may start JetBrains MPS from any directory.
37
38 HOW TO ADJUST JVM OPTIONS
39     1. [MAC OS X]
40        If you run JetBrains MPS by clicking on MPS.app folder, you should change Info.plist file,
41        located in {installation home}/Contents/ folder. Open it and find a line
42
43        <key>VMOptions</key>
44
45        The line next to this contains JVM options between "string" tags.
46        To adjust JVM heap size modify -Xms and -Xmx parameters in it.
47
48        If you run JetBrains MPS with mps.sh script, consider next section.
49
50     2. [OTHER PLATFORMS]
51        JVM options are located in {installation home}/bin/mps.vmoptions file.
52        To adjust the value of JVM heap size modify the -Xms and -Xmx parameters.
53
54 GETTING HELP AND REPORTING ISSUES
55     For getting help you can visit the following locations:
56     - home page http://www.jetbrains.com/mps/
57     - documentation http://confluence.jetbrains.net/display/MPSD20181/MPS+User%27s+Guide
58     - JetBrains MPS space http://confluence.jetbrains.com/display/MPS/Welcome+to+JetBrains+MPS+Space
59     - issue tracker http://www.jetbrains.net/tracker/issues/MPS
60     - forum https://mps-support.jetbrains.com/hc/en-us/community/topics
61
62 ----------------------
63 Develop with pleasure!
64 JetBrains MPS Team