Skip to content

Commit

Permalink
fix: Renaming repo names
Browse files Browse the repository at this point in the history
  • Loading branch information
drorganvidez committed Jun 27, 2024
1 parent dd1120a commit c2e6912
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
docker compose up -d --build
```

You can see the docs in `localhost:4000`
You can see the docs in `localhost:4001`

31 changes: 31 additions & 0 deletions assets/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,34 @@
.flamapy .blue {
color: #356C99;
}

.aux-nav-list-item{
font-size: 130%;
}

.center {
display: block;
margin-left: auto;
margin-right: auto;
}

.center-text {
text-align: center;
}

.btn-container {
display: inline-block;
}

.main-header {
justify-content: right !important;
}

.aux-nav {
padding-right: 0px !important;
}

.quarter-size {
width: 25%;
height: auto;
}
2 changes: 1 addition & 1 deletion core_and_plugins/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The core component is the main entry point of {% include flamapy.html %}.
> Official repository
>
> ```
> https://www.github.com/flamapy/core
> https://www.github.com/flamapy/flamapy_fw
> ```
## Description
Expand Down
2 changes: 1 addition & 1 deletion developing/setting_development_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ cd ~/flamapy
## Clone the core

```
git clone https://github.com/flamapy/core.git
git clone https://github.com/flamapy/flamapy_fw.git
```

## Clone plugins
Expand Down
14 changes: 7 additions & 7 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ nav_order: 2

## Installation

To analyze feature models, you can use the `flamapy-fm-dist` distribution. **It requires Python >= 3.9**.
To analyze feature models, you can use the `flamapy` distribution. **It requires Python >= 3.9**.

{: .important }
> It's recommended to use a **virtual environment** (venv) for installation to avoid conflicts with other packages. Here’s how you can set it up:
Expand All @@ -26,16 +26,16 @@ To analyze feature models, you can use the `flamapy-fm-dist` distribution. **It
Install the distribution:
```
pip install flamapy-fm-dist
pip install flamapy
```
## Basic operations
To test some basic operations, you need UVL models. Several are available at [UVLHub](https://www.uvlhub.io). If you prefer, you can download a test one:
```
wget -q "https://raw.githubusercontent.com/flamapy/flamapy-fm-dist/main/resources/models/valid_model.uvl"
wget -q "https://raw.githubusercontent.com/flamapy/flamapy-fm-dist/main/resources/configurations/valid_configuration.csvconf"
wget -q "https://raw.githubusercontent.com/flamapy/flamapy/main/resources/models/simple/valid_model.uvl"
wget -q "https://raw.githubusercontent.com/flamapy/flamapy/main/resources/configurations/valid_configuration.csvconf"
```
### Validate the model
Expand Down Expand Up @@ -69,15 +69,15 @@ flamapy-fm-cli --modelPath="./valid_model.uvl" valid_configuration ./valid_confi
### Option 1: using the feature models distribution.
We have prepared the `flamapy-fm-dist` distribution which acts as an interface and is specific to feature models.
We have prepared the `flamapy` distribution which acts as an interface and is specific to feature models.
### Option 2: Without using the feature models distribution
You can choose not to use the distribution. In that case, **you have to install the core and the corresponding plugin in developer mode**.
To set up your environment in developer mode and work directly with the plugins, visit the section ['Setting the development environment']({{site.baseurl}}/docs/developing/setting_development_environment/)
To set up your environment in developer mode and work directly with the plugins, visit the section ['Setting the development environment']({{site.baseurl}}/developing/setting_development_environment/)
You can check the rest of [operations]({{site.baseurl}}/docs/core_and_plugins/fm/) of the plugin for feature models.
You can check the rest of [operations]({{site.baseurl}}/core_and_plugins/fm/) of the plugin for feature models.
## I want to use more operations other plugins.
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ When contributing to this repository, please first read [contributing].

[getting-started]: {% link getting-started.md %}

[release notes]: https://github.com/flamapy/core/releases
[release notes]: https://github.com/flamapy/flamapy_fw/releases

[contributing]: {% link contributing/contributing.md %}

0 comments on commit c2e6912

Please sign in to comment.