Selaa lähdekoodia

readme review; Nice GUI --> NiceGUI

Falko Schindler 4 vuotta sitten
vanhempi
säilyke
04d63fc997
3 muutettua tiedostoa jossa 10 lisäystä ja 11 poistoa
  1. 8 9
      README.md
  2. 1 1
      nice_gui/nice_gui.py
  3. 1 1
      spike_reload/main.py

+ 8 - 9
README.md

@@ -1,17 +1,16 @@
-# Nice GUI
+# NiceGUI
 
 <img src="sceenshots/ui-elements.png?raw=true" width="300" align="right">
 
-We like [Streamlit](https://streamlit.io/) but find it does to much magic when it comes to state handling. In search for an alernative nice library to write simple graphical user interfaces in Python we discovered [justpy](https://justpy.io/). While to "low-level-html" for our daily usage it provides a great basis for our shot at a "Nice GUI".
-
+We like [Streamlit](https://streamlit.io/) but find it does to much magic when it comes to state handling. In search for an alernative nice library to write simple graphical user interfaces in Python we discovered [justpy](https://justpy.io/). While too "low-level-html" for our daily usage it provides a great basis for our shot at a "NiceGUI".
 
 ## Features
 
-- browser based GUI
+- browser-based GUI
 - implicit reload on code change
-- clean set of gui elements (label, button, checkbox, switch, slider, input, ...)
+- clean set of GUI elements (label, button, checkbox, switch, slider, input, ...)
 - simple grouping with rows, columns and cards
-- buildin timer to refresh data in intervals (even every 10 ms)
+- built-in timer to refresh data in intervals (even every 10 ms)
 
 ## Usage
 
@@ -20,7 +19,7 @@ Write your nice GUI in a file `main.py`:
 ```python
 from nice_gui import ui
 
-ui.label('Hello Nice GUI!')
+ui.label('Hello NiceGUI!')
 ui.button('BUTTON', on_click: lambda: print('button was pressed'))
 ```
 
@@ -30,11 +29,11 @@ Launch it with:
 python3 main.py
 ```
 
-Note: the script will automatically reload the GUI if you modify your code.
+Note: The script will automatically reload the GUI if you modify your code.
 
 ## API
 
-See [main.py](https://github.com/zauberzeug/nice_gui/blob/main/main.py) for an example of all API calls you can make with Nice GUI.
+See [main.py](https://github.com/zauberzeug/nice_gui/blob/main/main.py) for an example of all API calls you can make with NiceGUI.
 
 ## Plots
 

+ 1 - 1
nice_gui/nice_gui.py

@@ -12,7 +12,7 @@ if not inspect.stack()[-2].filename.endswith('spawn.py'):
     uvicorn.run('nice_gui:app', host='0.0.0.0', port=80, lifespan='on', reload=True)
     sys.exit()
 
-wp = jp.QuasarPage(delete_flag=False, title='Nice GUI', favicon='favicon.png')
+wp = jp.QuasarPage(delete_flag=False, title='NiceGUI', favicon='favicon.png')
 wp.head_html = '<script>confirm = () => true;</script>'  # avoid confirmation dialog for reload
 
 main = jp.Div(a=wp, classes='q-ma-md column items-start', style='row-gap: 1em')

+ 1 - 1
spike_reload/main.py

@@ -2,7 +2,7 @@
 from nice_gui import ui, pad
 
 print(pad, __name__, "MAIN: create label")
-ui.label('hello nice gui!')
+ui.label('Hello NiceGUI!')
 
 print(pad, __name__, "MAIN: create timer")
 ui.timer()