Skip to content

Commit

Permalink
Workflow state description README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
franziska-wegner authored Dec 5, 2023
1 parent 1300bce commit 48c727f
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,31 @@

Energy Grid Optimization and Analysis (EGOA) is a framework for energy grid analysis and planning.

<h2>Workflow State</h2>

The CMake multi-platform workflow currently tests the framework on ubuntu using clang and gcc, and windows. If the flag is green the framework is working on all platforms mentioned.

[![CMake on multiple platforms](https://github.com/franziska-wegner/egoa/actions/workflows/cmake-multi-platform.yml/badge.svg?branch=master)](https://github.com/franziska-wegner/egoa/actions/workflows/cmake-multi-platform.yml)

<h2>Installation</h2>

This is a Cmake project and can be run in any C++ IDE (Integrated Development Environment) that is on the market and supports CMake. You have to define a certain set of parameters dependent on your system and what you wish to run in general. The following will help you with the initial setup and links to the frameworks that can be linked in addition.
This is a Cmake project and can be run in any C++ IDE (Integrated Development Environment) that is on the market and supports CMake. You have to define a certain set of parameters dependent ozn your system and what you wish to run in general. The following description will help you with the initial setup. The links to frameworks that can be linked to this project are given in addition.

<h3>Required Preinstallations</h3>

The Qt can be installed on a Mac using:
The Qt project can be installed on a Mac using

```
brew install qt
```

The compiler clang and gcc can be installed on a Mac using:
and on Ubuntu using

```
sudo apt-get install qt
```

The compiler clang and gcc can be installed on a Mac using the following command or you use the Apple clang compiler if necessary.

```
brew install llvm
Expand Down

0 comments on commit 48c727f

Please sign in to comment.