bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-14 11:41:49 +02:00
Code Activity

docs: review developer section; add introduction

Browse Source
This commit is contained in:
appel_c
2024-08-08 22:54:30 +02:00
parent a4a0bac3c1
commit 2af5c94913
6 changed files with 50 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/developer/introduction/introduction.md Normal file
View File

@ -0,0 +1,15 @@
(developer.introduction)=
# Introduction
BEC Widgets is a framework providing modular components that can be integrated into various larger GUI applications. Each widget serves a specific purpose adhering to the single-responsibility principle as detailed in our [concepts section](developer.concepts), and offers a straightforward, user-friendly interface.
These widgets provide data visualisation tools and experimental control interfaces by triggering actions within BEC.
If you're interested in contributing to BEC Widgets, please refer to our [contributing guide](developer.contributing), which provides instructions for setting up your development environment and creating your own widgets.
```{toctree}
---
maxdepth: 2
hidden: false
---
concepts/
contributing/
```