Skip to content

Commit 602d273

Browse files
committed
Refactor README.md for clarity and formatting improvements
1 parent 2469484 commit 602d273

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@
44

55
## Abstract
66

7-
This Python package is designed to facilitate the connection between the [OpenStaad API](https://docs.bentley.com/LiveContent/web/STAAD.Pro%20Help-v14/en/GUID-93E26CB6-E60E-4175-920A-72D504639722.html) and python.
7+
openstaad python is a starting project to wrap the official OpenStaad API functionalities into a Python package.
8+
9+
It aims to facilitate the connection with the [OpenStaad API](https://docs.bentley.com/LiveContent/web/STAAD.Pro%20Help-v14/en/GUID-93E26CB6-E60E-4175-920A-72D504639722.html) functions, avoiding boilerplate code and type management, allowing the user to focus on the real automation tasks.
810

911
## Quick Info
1012

1113
- `openstaad` is a Python package to call easily functions from the OpenStaad API.
14+
- Require a StaadPRO and a valid file open to connect
1215
- MIT-License
1316
- The intended audience is StaadPro users with knowledge of Python
1417
- Compatibitity:
@@ -17,14 +20,15 @@ This Python package is designed to facilitate the connection between the [OpenSt
1720
- Dependencies:
1821
- [comtypes](https://pypi.org/project/comtypes/)
1922

20-
- See [implemented funcionts](docs/implemented.md) for a list of currently working features.
2123
- Please contact the [developer](openstee611@gmail.com) for requests.
2224

2325
## Installation
2426

2527
Basic installation by pip.
2628

27-
pip install openstaad
29+
```bash
30+
pip install openstaad
31+
```
2832

2933
## A simple example
3034

@@ -54,11 +58,7 @@ print(beam_nodes)
5458

5559
## Website
5660

57-
Not yet implemented
58-
59-
## Documentation
60-
61-
See [documentation](/docs/) folder
61+
[www.openstaad.com](https://www.openstaad.com/)
6262

6363
## Contribution
6464

@@ -70,21 +70,16 @@ https://github.com/OpenStaad/OpenStaadPython/pulls
7070
## Feedback
7171

7272
Questions and feedback at __GitHub Discussions__:
73-
7473
https://github.com/OpenStaad/OpenStaadPython/discussions
7574

76-
Questions at __Stack Overflow__:
77-
78-
Post questions at [stack overflow](https://stackoverflow.com/) and use the tag `openstaad` or `openstaadpython`.
79-
80-
Issue tracker at __GitHub__: https://github.com/OpenStaad/OpenStaadPython/issues
75+
Issue tracker at __GitHub__:
76+
https://github.com/OpenStaad/OpenStaadPython/issues
8177

8278
## Contact
8379

8480
Please __always__ post questions at the [forum](https://github.com/OpenStaad/OpenStaadPython/discussions)
85-
or [stack overflow](https://stackoverflow.com/) to make answers
86-
available to other users as well.
81+
to make answers available to other users as well.
8782

8883
Feedback is greatly appreciated.
8984

90-
Konrad
85+
Konrad

0 commit comments

Comments
 (0)