diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..bfe27afdf030c54f86e26e86250b6911499fb844 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,24 @@ +image: python:3.8-buster + +before_script: + - pip install -r requirements.txt + +test: + stage: test + script: + - mkdocs build --strict --verbose --site-dir test + artifacts: + paths: + - test + except: + - master + +pages: + stage: deploy + script: + - mkdocs build --strict --verbose + artifacts: + paths: + - public + only: + - master diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..1f620b397480447da6af47efe291906d23ddc7b7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,24 @@ +# FRaMED SPL (2.0) + + +The *Full-fledged Role Modeling EDitor Software Product Line* (FRaMED SPL) (Version 2.0) is the reimplementation of FRaMED allowing the graphical specification of Role-based Software Systems by means of *compartments* (aka. *contexts*), *objects*, *roles*, and *relationships*. Moreover, it supports a varity of constraints upon roles and relationships. + +While this was already possible in [FRaMED](https://github.com/leondart/FRaMED), this editor is a feature modular *graphical editor product line* (GEPL)¹ that permits users to dynamically reconfigure the available concepts, as well as constraints and developers to modularly extending the language family adding and removing concepts and constraints. + +Further information can be found in the [wiki](https://github.com/Eden-06/FRaMED-2.0/wiki). + + + +¹) Thomas Kühn, Kevin Ivo Kassin, Walter Cazzola, and Uwe Aßmann, *Modular Feature-Oriented Graphical Editor Product Lines*. In Proceedings of the 22th International Software Product Line Conference, ACM, 2018. + +## Installation for Users + +1. Install a Java 8 runtime environment +2. Download and run the appropriate build for your system: + - Windows: [64 bit zip](https://git-st.inf.tu-dresden.de/rosi/framed/-/raw/master/build/win32.win32.x86_64.zip) + - Linux: [64 bit zip](https://git-st.inf.tu-dresden.de/rosi/framed/-/raw/master/build/linux.gtk.x86_64.zip) + - Mac OS: [64 bit zip](https://git-st.inf.tu-dresden.de/rosi/framed/-/raw/master/build/macosx.cocoa.x86_64.zip) + +## Installation for Developers + +Please follow the [instructions on Github](https://github.com/Eden-06/FRaMED-2.0/wiki/Install). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000000000000000000000000000000000..588b328ffddbacef068e537e93a1433a045f0966 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: FRAmED +site_url: https://pages.gitlab.io/mkdocs +site_dir: public +theme: readthedocs