Skip to content

Commit aaa3717

Browse files
bandit-maskedhoffstadt
bandit-masked
and
hoffstadt
authored
docs: Redesign of the GitHub readme.md (by testpilot) (hoffstadt#1720)
* Redesign of the GitHub readme.md (by testpilot) Even though there still are improvements to be made, this redesign provides a streamlined version of the current readme while also highlighting additional information, such as the demo and developer tools. The complete redesign can be viewed using the URL below. https://github.com/DataExplorerUser/readme_examples/blob/main/readme.md * update readme following response by cothren update readme following response by cothren as described here hoffstadt#1720 - make all headers the same type - remove section about functionality - remove section about tools Co-authored-by: Jonathan Hoffstadt <[email protected]>
1 parent 3997972 commit aaa3717

File tree

1 file changed

+126
-118
lines changed

1 file changed

+126
-118
lines changed

‎README.md

Lines changed: 126 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,68 @@
1-
<a id="user-content-dear-pygui" class="anchor" aria-hidden="true" href="#dear-pygui">
2-
3-
<div align="center">
4-
<img src="https://github.com/hoffstadt/DearPyGui/blob/assets/newlogo.jpg?raw=true" alt="Dear PyGui">
5-
</div>
6-
7-
</a>
8-
9-
<h6 align="center">(This library is available under a free and permissive license however, if you are using Dear PyGui please consider becoming a <a href="https://github.com/hoffstadt/DearPyGui/wiki/Sponsors">Sponsor</a>)</h6>
10-
11-
![Python Version](https://img.shields.io/pypi/pyversions/dearpygui)
12-
[![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/)
13-
[![Downloads](https://pepy.tech/badge/dearpygui)](https://pepy.tech/project/dearpygui)
14-
15-
[![build status](https://github.com/hoffstadt/DearPyGui/workflows/Embedded%20Build/badge.svg?branch=master)](https://github.com/hoffstadt/DearPyGui/actions?workflow=Embedded%20Build)
16-
[![static-analysis](https://github.com/hoffstadt/DearPyGui/workflows/Static%20Analysis/badge.svg?branch=master)](https://github.com/hoffstadt/DearPyGui/actions?workflow=Static%20Analysis)
17-
[![Deployment](https://github.com/hoffstadt/DearPyGui/actions/workflows/Deployment.yml/badge.svg?branch=master)](https://github.com/hoffstadt/DearPyGui/actions/workflows/Deployment.yml)
18-
[![Documentation Status](https://readthedocs.org/projects/dearpygui/badge/?version=latest)](https://dearpygui.readthedocs.io/en/latest/?badge=latest)
19-
20-
**Dear PyGui** is a **simple to use (but powerful) Python GUI framework**. _Dear PyGui_ is **NOT** a wrapping of **[Dear ImGui](https://github.com/ocornut/imgui)** in the normal sense. It is a library built with _Dear ImGui_.
21-
22-
<BR>![Themes](https://github.com/hoffstadt/DearPyGui/blob/assets/linuxthemes.PNG?raw=true)
23-
24-
**Dear PyGui is fundamentally different than other Python GUI frameworks**. Under the hood, _Dear PyGui_
25-
uses the immediate mode paradigm and your computer's GPU to facilitate extremely dynamic interfaces. _Dear PyGui_ is currently supported on
26-
the following platforms:
27-
28-
| Platform | Graphics API | Newest Version |
29-
|----------|---------------|----------------|
30-
| **Windows 10** | _DirectX 11_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
31-
| **macOS** | _Metal_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
32-
| **Linux** | _OpenGL 3_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
33-
| **Raspberry Pi 4** | _OpenGL ES_ | [![PYPI](https://img.shields.io/badge/pypi-v1.6-blue)](https://img.shields.io/badge/pypi-v1.6-blue) |
34-
35-
In the same manner Dear ImGui provides a simple way to create tools for game developers, _Dear PyGui_ provides a
36-
simple way for python developers to **create quick and powerful GUIs for scripts**.
37-
38-
| [Installation](#installation) - [Usage](#usage) - [Resources](#resources) - [Support](#support) |
39-
:----------------------------------------------------------: |
40-
| [Features](#features) - [Sponsors](#sponsors) - [Credits](#credits) - [License](#license) - [Gallery](#gallery) |
41-
1+
<h1 align="center">
2+
<br>
3+
<a href="https://github.com/hoffstadt/DearPyGui"><img src="https://raw.githubusercontent.com/hoffstadt/DearPyGui/assets/readme/dpg_logo_button.png" alt="Dear PyGui logo"></a>
4+
</h1>
5+
6+
<h4 align="center">A modern, fast and powerful GUI framework for Python</h4>
7+
8+
<h1></h1>
9+
10+
<p align="center">
11+
<a href=""><img src="https://img.shields.io/pypi/pyversions/dearpygui" alt="Python versions"></a>
12+
<a href="https://pypi.org/project/dearpygui/"><img src="https://img.shields.io/pypi/v/dearpygui" alt="PYPI"></a>
13+
<a href="https://pepy.tech/project/dearpygui"><img src="https://pepy.tech/badge/dearpygui" alt="Downloads"></a>
14+
<a href="#license"><img src="https://github.com/hoffstadt/DearPyGui/blob/assets/readme/mit_badge.svg" alt="MIT License"></a>
15+
</p>
16+
17+
<p align="center">
18+
<a href="https://github.com/hoffstadt/DearPyGui/actions?workflow=Embedded%20Build"><img src="https://github.com/hoffstadt/DearPyGui/workflows/Embedded%20Build/badge.svg?branch=master" alt="static-analysis"></a>
19+
<a href="https://github.com/hoffstadt/DearPyGui/actions?workflow=Static%20Analysis"><img src="https://github.com/hoffstadt/DearPyGui/workflows/Static%20Analysis/badge.svg?branch=master" alt="static-analysis"></a>
20+
<a href="https://github.com/hoffstadt/DearPyGui/actions/workflows/Deployment.yml"><img src="https://github.com/hoffstadt/DearPyGui/actions/workflows/Deployment.yml/badge.svg?branch=master" alt="Deployment"></a>
21+
<a href="https://dearpygui.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/dearpygui/badge/?version=latest" alt="Documentation Status"></a>
22+
</p>
23+
24+
<h1></h1>
25+
26+
<p align="center">
27+
<a href="#features">Features</a> •
28+
<a href="#installation">Installation</a> •
29+
<a href="#how-to-use">How To Use</a> •
30+
<a href="#demo">Demo</a> •
31+
<a href="#resources">Resources</a> •
32+
<a href="#support">Support</a> •
33+
<a href="#tech-stack">Tech stack</a> •
34+
<a href="#credits">Credits</a> •
35+
<a href="#license">License</a> •
36+
<a href="#gallery">Gallery</a>
37+
</p>
38+
39+
<h1></h1>
40+
41+
<BR>![Themes](https://raw.githubusercontent.com/hoffstadt/DearPyGui/assets/linuxthemes.PNG)
42+
43+
## Features
44+
- **Modern look** — Complete theme and style control
45+
- **Great performance** — GPU-based rendering and efficient C/C++ code
46+
- **Stable operation** — Asynchronous function support
47+
- **Fast graphs** — Display over 1 million datapoints at 60 fps, zoom and pan
48+
- **Node editor** — Intuitive user interaction
49+
- **Built-in demo** — Quickly learn all features
50+
- **Developer tools** — Theme and resource inspection, runtime metrics, debugger
51+
- **Cross-platform** — Windows, Linux, MacOS
52+
- **MIT license**
53+
54+
<h1></h1>
55+
<p align="center">
56+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/stem.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/tables.gif" width="380">
57+
</p>
58+
<h1></h1>
59+
60+
<h1></h1>
61+
<p align="center">
62+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/pie.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/candle.gif" width="380">
63+
</p>
64+
<h1></h1>
65+
4266
## Installation
4367

4468
Ensure you have at least Python 3.7 64bit.
@@ -48,39 +72,10 @@ Ensure you have at least Python 3.7 64bit.
4872
pip3 install dearpygui
4973
```
5074

51-
52-
## Resources
53-
54-
[![Chat on Discord](https://img.shields.io/discord/736279277242417272?logo=discord)](https://discord.gg/tyE7Gu4)
55-
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/dearpygui?label=r%2Fdearpygui)](https://www.reddit.com/r/DearPyGui/)
75+
## How to use?
5676

57-
- [Contributor Documentation](https://github.com/hoffstadt/DearPyGui/wiki)
58-
- [User Documentation](https://dearpygui.readthedocs.io/en/latest/index.html) comprehensive documentation, tutorials, and examples.
59-
- [Development Roadmap](https://github.com/hoffstadt/DearPyGui/projects/4) major future features and changes.
60-
- [Feature Tracker](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+feature%22) all proposed new features.
61-
- [Bug Tracker](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22) current bugs and issues.
62-
- Internal Documentation: Run the `show_documentation` command from within the library to view a reference guide.
63-
- Complete Demo: You can also view a mostly complete showcase of _Dear PyGui_ by running:
64-
```python
65-
import dearpygui.dearpygui as dpg
66-
from dearpygui.demo import show_demo
67-
68-
dpg.create_context()
69-
dpg.create_viewport()
70-
dpg.setup_dearpygui()
71-
72-
show_demo()
73-
74-
dpg.show_viewport()
75-
dpg.start_dearpygui()
76-
dpg.destroy_context()
77-
```
78-
79-
## Usage
80-
81-
Using _Dear PyGui_ is as simple as creating a python script like the one below:
82-
83-
Code:
77+
Using Dear PyGui is as simple as the following Python script.
78+
8479
```Python
8580
import dearpygui.dearpygui as dpg
8681

@@ -101,72 +96,85 @@ dpg.show_viewport()
10196
dpg.start_dearpygui()
10297
dpg.destroy_context()
10398
```
104-
Result:
105-
<BR>![BasicUsageExample](https://github.com/hoffstadt/DearPyGui/blob/assets/BasicUsageExample1.PNG?raw=true)
106-
99+
<br/>
100+
<p align="center"><a href="https://dearpygui.readthedocs.io/en/latest/tutorials/first-steps.html#first-run"><img src="https://raw.githubusercontent.com/hoffstadt/DearPyGui/assets/readme/first_app.gif" alt="Dear PyGui example window"></a></p>
101+
102+
## Demo
103+
The built-in demo shows all of Dear PyGui's functionality. Use [this code](https://dearpygui.readthedocs.io/en/latest/tutorials/first-steps.html#demo) to run the demo. The following impression shows a few, but not nearly all, of the available widgets and features. Since the Python code of the demo can be <a href="https://github.com/hoffstadt/DearPyGui/blob/master/DearPyGui/dearpygui/demo.py" alt="demo code repository">inspected</a>, you can leverage the demo code to build your own apps.
104+
<br/><br/>
105+
<p align="center"><a href="https://dearpygui.readthedocs.io/en/latest/tutorials/first-steps.html#demo"><img src="https://raw.githubusercontent.com/hoffstadt/DearPyGui/assets/readme/demo.gif" alt="Dear PyGui demo"></a></p>
106+
107+
## Resources
107108

108-
## Features
109+
- [API documentation](https://dearpygui.readthedocs.io/en/latest/index.html) :books:
110+
- [Development Roadmap](https://github.com/hoffstadt/DearPyGui/projects/4)
111+
- [FAQ](https://github.com/hoffstadt/DearPyGui/discussions/categories/frequently-asked-questions-faq)
112+
- [Feature Tracker](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+feature%22)
113+
- [Bug Tracker](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22)
114+
- [Showcase apps including source code](https://github.com/hoffstadt/DearPyGui/wiki/Dear-PyGui-Showcase) :star:
115+
116+
## Support
109117

110-
#### Plotting/Graphing
111-
_Dear PyGui_ includes a plotting API built with [ImPlot](https://github.com/epezent/implot)
118+
If you are having issues or want to help, here are some places you can go.
119+
- [Discord Forum](https://discord.gg/tyE7Gu4) 💬
120+
- [Reddit](https://www.reddit.com/r/DearPyGui/)
112121

113-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/controls.gif" width="270"> <img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/dnd.gif" width="270"> <img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/pie.gif" width="270">
122+
[![Chat on Discord](https://img.shields.io/discord/736279277242417272?logo=discord)](https://discord.gg/tyE7Gu4) &nbsp; &nbsp; &nbsp; [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/dearpygui?label=r%2Fdearpygui)](https://www.reddit.com/r/DearPyGui/)
114123

115-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/query.gif" width="270"> <img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/bars.gif" width="270">
116-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/rt.gif" width="270">
124+
## Tech stack
125+
Dear PyGui is built on top of <a href="https://github.com/ocornut/imgui" target="_blank">Dear ImGui</a>, including the [ImPlot](https://github.com/epezent/implot) and [imnodes](https://github.com/Nelarius/imnodes) extensions, and is fundamentally different than other Python GUI frameworks. Under the hood, it uses the immediate mode paradigm and your computer's GPU to facilitate extremely dynamic interfaces. In the same manner Dear ImGui provides a simple way to create tools for game developers, Dear PyGui provides a simple way for python developers to create quick and powerful GUIs for scripts. Dear PyGui is written in C/C++ resulting in highly performant Python applications. Dear PyGui is currently supported on the following platforms.
126+
<br/>
127+
128+
| Platform | Graphics API | Newest Version |
129+
|:---------|:-------------|:---------------|
130+
| **Windows 10** | _DirectX 11_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
131+
| **macOS** | _Metal_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
132+
| **Linux** | _OpenGL 3_ | [![PYPI](https://img.shields.io/pypi/v/dearpygui)](https://pypi.org/project/dearpygui/) |
133+
| **Raspberry Pi 4** | _OpenGL ES_ | [![PYPI](https://img.shields.io/badge/pypi-v1.6-blue)](https://img.shields.io/badge/pypi-v1.6-blue) |
117134

118-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/stem.gif" width="270"> <img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/markers.gif" width="270">
119-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/shaded.gif" width="270">
135+
136+
## Credits
120137

121-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/candle.gif" width="270"> <img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/heat.gif" width="270">
122-
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/tables.gif" width="270">
138+
- Developed by [Jonathan Hoffstadt](https://github.com/hoffstadt), [Preston Cothren](https://github.com/Pcothren) and every direct or indirect contributor.
123139

124-
#### Node Editor
125-
_Dear PyGui_ includes a node editor built with [imnodes](https://github.com/Nelarius/imnodes)
126-
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/nodes2.png)
140+
- [Omar Cornut](http://www.miracleworld.net/) for all his incredible work on [Dear ImGui](https://github.com/ocornut/imgui).
127141

142+
- [Evan Pezent](http://evanpezent.com/) for all his work on [ImPlot](https://github.com/epezent/implot).
128143

129-
#### Canvas
130-
_Dear PyGui_ includes a drawing API to create custom drawings, plot, and even 2D games.
131-
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/tetris.png)
132-
133-
#### Tools
134-
_Dear PyGui_ includes several tools to help developers with _DearPyGui_ app development:
135-
<BR>![BasicUsageExample](https://github.com/hoffstadt/DearPyGui/blob/assets/tools.png?raw=true)
144+
- [Johann Muszynski](https://github.com/Nelarius) for all of his work on [imnodes](https://github.com/Nelarius/imnodes).
136145

146+
## License
147+
Dear PyGui is licensed under the [MIT License](https://github.com/hoffstadt/DearPyGui/blob/master/LICENSE).
148+
149+
## Sponsor
150+
Continued maintenance and development are a full-time endeavor which we would like to sustain and grow. Ongoing development is financially supported by users and private sponsors. If you enjoy Dear PyGui please consider becoming a [sponsor](https://github.com/hoffstadt/DearPyGui/wiki/Sponsors) or buy us a [cup of coffee](https://www.buymeacoffee.com/DearPyGui).
137151

138-
## Support
139-
140-
If you are having issues or want to help, here are some places you can go:
141-
- [Github Discussions](https://github.com/hoffstadt/DearPyGui/discussions/)
142-
- [Discord Forum](https://discord.gg/tyE7Gu4)
143-
- [Reddit](https://www.reddit.com/r/DearPyGui/)
144-
145-
## Sponsors
152+
<img src="https://img.shields.io/github/sponsors/hoffstadt?label=Github%20Sponsors">&nbsp; &nbsp; &nbsp; <img src="https://img.shields.io/opencollective/sponsors/dearpygui?label=Open%20Collective%20Sponsors">
146153

147-
![GitHub Sponsors](https://img.shields.io/github/sponsors/hoffstadt?label=Github%20Sponsors)
148-
![Open Collective](https://img.shields.io/opencollective/sponsors/dearpygui?label=Open%20Collective%20Sponsors)
154+
## Gallery
149155

150-
Ongoing _Dear PyGui_ development is financially supported by users and private sponsors.
151-
If you enjoy _Dear PyGui_ please consider becoming a [sponsor](https://github.com/hoffstadt/DearPyGui/wiki/Sponsors).
156+
#### Plotting/Graphing
157+
_Dear PyGui_ includes a plotting API built with [ImPlot](https://github.com/epezent/implot)
152158

153-
<a href="https://www.buymeacoffee.com/DearPyGui"><img src="https://img.buymeacoffee.com/button-api/?text=Buy us a coffee&emoji=&slug=DearPyGui&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff"></a>
159+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/controls.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/dnd.gif" width="380">
154160

155-
## Credits
161+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/query.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/bars.gif" width="380">
162+
163+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/rt.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/markers.gif" width="380">
164+
165+
<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/shaded.gif" width="380">&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;<img src="https://raw.githubusercontent.com/wiki/epezent/implot/screenshots3/heat.gif" width="380">
156166

157-
Developed by [Jonathan Hoffstadt](https://github.com/hoffstadt), [Preston Cothren](https://github.com/Pcothren), and every direct or indirect contributor.
158167

159-
[Omar Cornut](http://www.miracleworld.net/) for all his incredible work on [Dear ImGui](https://github.com/ocornut/imgui).
168+
#### Node Editor
169+
_Dear PyGui_ includes a node editor built with [imnodes](https://github.com/Nelarius/imnodes)
170+
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/nodes2.png)
160171

161-
[Evan Pezent](http://evanpezent.com/) for all his work on [ImPlot](https://github.com/epezent/implot).
162172

163-
[Johann Muszynski](https://github.com/Nelarius) for all of his work on [imnodes](https://github.com/Nelarius/imnodes).
173+
#### Canvas
174+
_Dear PyGui_ includes a drawing API to create custom drawings, plot, and even 2D games.
175+
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/tetris.png)
164176

165-
## License
166177

167-
_Dear PyGui_ is licensed under the [MIT License](https://github.com/hoffstadt/DearPyGui/blob/master/LICENSE).
168-
169-
## Gallery
170178
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/3d.png)
171179

172180
![](https://github.com/hoffstadt/DearPyGui/blob/assets/readme/nodes1.png)

0 commit comments

Comments
 (0)