Skip to content

Commit bb65b7c

Browse files
Better installation info
1 parent f1c6036 commit bb65b7c

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,17 @@ To access and visualize the data:
7272

7373
## ⬇️ Installation
7474

75+
### Intsalling DifFlexMM only
76+
7577
Assuming you have access to the repo and ssh keys are set up in your GitHub account, you can install the package with
7678

7779
```bash
7880
pip install git+ssh://[email protected]/bertoldi-collab/DifFlexMM.git
7981
```
8082

81-
or you can clone the repository, `cd` into the `DifFlexMM` folder, and install with
83+
### Installing DifFlexMM with examples of solved design problems
84+
85+
Clone the repository, `cd` into the `DifFlexMM` folder, and install with
8286

8387
```bash
8488
pip install -e .
@@ -93,8 +97,8 @@ The dependency management of the project is done via [poetry](https://python-poe
9397

9498
To get started:
9599

96-
- Install [poetry](https://python-poetry.org/docs/)
97-
- Clone the repo
100+
- Install [poetry](https://python-poetry.org/docs/).
101+
- Clone the repository.
98102
- `cd` into the root directory and run `poetry install`. This will create the poetry environment with all the necessary dependencies.
99103
- If you are using vscode, search for `venv path` in the settings and paste `~/.cache/pypoetry/virtualenvs` in the `venv path` field. Then select the poetry enviroment as python enviroment for the project.
100104

0 commit comments

Comments
 (0)