Skip to content

Commit 5776cad

Browse files
authored
Update README.md (#55)
1 parent 536bb6c commit 5776cad

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@
1414
[![Ankaios](https://img.shields.io/badge/main_project-repo-blue)](https://github.com/eclipse-ankaios/ankaios)
1515
[![Slack](https://img.shields.io/badge/slack-join-blue?logo=slack)](https://join.slack.com/t/ankaios/shared_invite/zt-2inyhbehh-iVp3YZD09VIgybv8D1gDpQ)
1616

17-
[Eclipse Ankaios](https://github.com/eclipse-ankaios/ankaios) provides workload and container orchestration for automotive
18-
High Performance Computers (HPCs). While it can be used for various fields of
19-
applications, it is developed from scratch for automotive use cases and provides
20-
a slim yet powerful solution to manage containerized applications.
17+
[Eclipse Ankaios](https://github.com/eclipse-ankaios/ankaios) provides workload and
18+
container orchestration for automotive High Performance Computing Platforms (HPCs).
19+
While it can be used for various fields of applications, it is developed from scratch
20+
for automotive use cases and provides a slim yet powerful solution to manage
21+
containerized applications.
2122

2223
The Python SDK provides easy access from the container (workload) point-of-view
2324
to manage the Ankaios system. A workload can use the Python SDK to start, stop and
@@ -46,11 +47,14 @@ pip install -e ".[dev]"
4647
```
4748

4849
> **Note:**
49-
> Depending on your Linux distribution, it could be that you need to create and activate a [virtual environment](https://docs.python.org/3/library/venv.html) to run the pip commands.
50+
> Depending on your Linux distribution, it could be that you need to create and
51+
> activate a [virtual environment](https://docs.python.org/3/library/venv.html)
52+
> to run the pip commands.
5053
5154
## Compatibility
5255

53-
Please make sure the Python SDK is compatible with the version of Ankaios you are using. For information regarding versioning, please refer to this table:
56+
Please make sure the Python SDK is compatible with the version of Ankaios you
57+
are using. For information regarding versioning, please refer to this table:
5458

5559
| Ankaios | Python SDK |
5660
| -------- | ------- |
@@ -59,8 +63,8 @@ Please make sure the Python SDK is compatible with the version of Ankaios you ar
5963

6064
## Usage
6165

62-
After installation, you can use the Ankaios SDK to configure and run workloads and request
63-
the state of the Ankaios system and the connected agents.
66+
After installation, you can use the Ankaios SDK to configure and run workloads
67+
and request the state of the Ankaios system and the connected agents.
6468

6569
The following example assumes that the code is running in a managed by
6670
Ankaios workload with configured control interface access:
@@ -131,7 +135,8 @@ For more details, please visit:
131135
* [Ankaios documentation](https://eclipse-ankaios.github.io/ankaios/latest/)
132136
* [Python SDK documentation](https://eclipse-ankaios.github.io/ank-sdk-python/)
133137

134-
Especially the Ankaios [fleet management tutorial](https://eclipse-ankaios.github.io/ankaios/latest/usage/tutorial-fleet-management/) gives a great overview on the usage of the SDK.
138+
Especially the Ankaios [fleet management tutorial](https://eclipse-ankaios.github.io/ankaios/latest/usage/tutorial-fleet-management/)
139+
gives a great overview on the usage of the SDK.
135140

136141
## Contributing
137142

0 commit comments

Comments
 (0)