Commit 3e8e83f7 authored by Alvaro Mario Veizaga Campero's avatar Alvaro Mario Veizaga Campero
Browse files

Update README.md

parent af842b4d
# Rimay a Controlled Natural Language for Functional Requirements
Rimay is a domain specific language for writing functional requirements in the financial domain. Rimay editor is implemented using the Xtext language engineering framework.
Rimay is a domain-specific language for writing functional requirements in the financial domain. Rimay's editor is implemented using the Xtext language engineering framework.
## Prerequisites:
- Java Runtime Environment
......@@ -8,18 +8,13 @@ Rimay is a domain specific language for writing functional requirements in the f
## Steps:
1. Open Eclipse and select a workspace
2. Use the Import wizard and select `General > Existing Projects into Workspace` to import the modules.
2. Run the file `dsl_rimay/org.xtext.dsl_rimay/src/org/xtext/Dsl_rimay.xtext` selection the option `Generate Xtext Artifacts`.
3. Select the root project `dsl_rimay/org.xtext.dsl_rimay/` and click in the `run` button and select `run as Eclipse application`
4. A new instance of Eclipse with the Rimay installed will be opened.
2. Use the Import wizard and select `General > Existing Projects into Workspace` to import the Rimay plugins (ide, ui, and dsl_rimay)
2. Run the file `dsl_rimay/org.xtext.dsl_rimay/src/org/xtext/Dsl_rimay.xtext` selecting the option `Generate Xtext Artifacts`.
3. Select the root project `dsl_rimay/org.xtext.dsl_rimay/` and click the `Run` button selectin `Run as Eclipse application`
4. A new instance of Eclipse including Rimay's editor will be opened
5. Create a file with the extension `.rimay` and you can start writing functional requirements
There is no public update site for DDK yet, so
import all plugins from this repository into a new Eclipse workspace
change current target to ddk.target
compile and export the four features available in the workspace (runtime, and the DDK itself)
Install the exported features into your Eclipse
## Examples of Functional Requirements written in Rimay:
......@@ -47,4 +42,15 @@ The SystemA must do the following actions in sequence:
## License:
TBD
All Rights Reserved
Copyright © SnT - Université du Luxembourg 2021
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment