|
| 1 | +.. container:: document |
| 2 | + |
| 3 | + `RIDE (Robot Framework |
| 4 | + IDE) <https://github.com/robotframework/RIDE/>`__ v2.0.6 is a new |
| 5 | + release with minor enhancements and bug fixes. The reference for |
| 6 | + valid arguments is `Robot Framework <https://robotframework.org/>`__ |
| 7 | + installed version, which is at this moment 6.0.2. However, internal |
| 8 | + library is based on version 3.1.2, to keep compatibility with old |
| 9 | + formats. |
| 10 | + |
| 11 | + - This version supports Python 3.6 up to 3.11. |
| 12 | + - There are some changes, or known issues: |
| 13 | + |
| 14 | + - When editing in Grid Editor with content assistance, the |
| 15 | + selected content can be edited by escaping the list of |
| 16 | + suggestions with keys ARROW_LEFT or ARROW_RIGHT. |
| 17 | + - Newlines in Grid Editor can be made visible with the \`filter |
| 18 | + newlines\` set to False. |
| 19 | + - On Text Editor when Saving the selection of tests in Test |
| 20 | + Suites (Tree) is cleared. |
| 21 | + - Test Suite with *\**\* Comments \**\** can be edited but |
| 22 | + newlines are introduced. |
| 23 | + - Some argument types detection (and colorization) is not correct |
| 24 | + in Grid Editor. |
| 25 | + - RIDE **DOES NOT KEEP** Test Suites formatting or structure, |
| 26 | + causing differences in files when used on other IDE or Editors. |
| 27 | + |
| 28 | + **New Features and Fixes Highlights** |
| 29 | + |
| 30 | + - Newlines in Grid Editor can be made visible with the \`filter |
| 31 | + newlines\` set to False, by editing \`settings.cfg\` |
| 32 | + - Improve auto-suggestions of keywords in Grid Editor by allowing to |
| 33 | + close suggestions list with keys ARROW_LEFT or ARROW_RIGHT |
| 34 | + - Improve Text Editor auto-suggestions by using: selected text, text |
| 35 | + at left or at right of cursor |
| 36 | + |
| 37 | + We hope to implement or complete features and make fixes on next |
| 38 | + major version 2.1 (in the end of 2023). |
| 39 | + |
| 40 | + **The minimal wxPython version is, 4.0.7, and RIDE supports the |
| 41 | + current version, 4.2.1.** |
| 42 | + |
| 43 | + *Linux users are advised to install first wxPython from .whl package |
| 44 | + at* |
| 45 | + `wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__, |
| 46 | + or by using the system package manager. |
| 47 | + |
| 48 | + The |
| 49 | + `CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__ |
| 50 | + lists the changes done on the different versions. |
| 51 | + |
| 52 | + All issues targeted for RIDE v2.1 can be found from the `issue |
| 53 | + tracker |
| 54 | + milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.1>`__. |
| 55 | + |
| 56 | + Questions and comments related to the release can be sent to the |
| 57 | + `robotframework-users <https://groups.google.com/group/robotframework-users>`__ |
| 58 | + mailing list or to the channel #ride on `Robot Framework |
| 59 | + Slack <https://robotframework-slack-invite.herokuapp.com>`__, and |
| 60 | + possible bugs submitted to the `issue |
| 61 | + tracker <https://github.com/robotframework/RIDE/issues>`__. You |
| 62 | + should see `Robot Framework |
| 63 | + Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your |
| 64 | + problem is already known. |
| 65 | + |
| 66 | + To install with `pip <https://pypi.org/project/pip/>`__ installed, |
| 67 | + just run |
| 68 | + |
| 69 | + .. code:: literal-block |
| 70 | +
|
| 71 | + pip install --upgrade robotframework-ride==v2.0.6 |
| 72 | +
|
| 73 | + to install exactly this release, which is the same as using |
| 74 | + |
| 75 | + .. code:: literal-block |
| 76 | +
|
| 77 | + pip install --upgrade robotframework-ride |
| 78 | +
|
| 79 | + Alternatively you can download the source distribution from |
| 80 | + `PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and |
| 81 | + install it manually. For more details and other installation |
| 82 | + approaches, see the `installation |
| 83 | + instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__. |
| 84 | + If you want to help in the development of RIDE, by reporting issues |
| 85 | + in current development version, you can install with: |
| 86 | + |
| 87 | + .. code:: literal-block |
| 88 | +
|
| 89 | + pip install -U https://github.com/robotframework/RIDE/archive/master.zip |
| 90 | +
|
| 91 | + Important document for helping with development is the |
| 92 | + `CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/master/CONTRIBUTING.adoc>`__. |
| 93 | + |
| 94 | + See the `FAQ <https://github.com/robotframework/RIDE/wiki/F.A.Q.>`__ |
| 95 | + for important info about : FOR changes and other known issues and |
| 96 | + workarounds. |
| 97 | + |
| 98 | + A possible way to start RIDE is: |
| 99 | + |
| 100 | + .. code:: literal-block |
| 101 | +
|
| 102 | + python -m robotide.__init__ |
| 103 | +
|
| 104 | + You can then go to Tools>Create RIDE Desktop Shortcut, or run the |
| 105 | + shortcut creation script with: |
| 106 | + |
| 107 | + .. code:: literal-block |
| 108 | +
|
| 109 | + python -m robotide.postinstall -install |
| 110 | +
|
| 111 | + RIDE v2.0.6 was released on 10/Jun/2023. |
0 commit comments