updated docs

This commit is contained in:
paul
2024-10-01 09:50:05 +05:30
parent 2ada8011e9
commit f8dbd10231
4 changed files with 16 additions and 9 deletions

View File

@@ -19,7 +19,7 @@
<p><img src="./repo-assets/logo/PyUi.png" alt="font tester logo" width="100" height="100"></p>
Build Python GUI's with the ease of Canva
Build Python GUI's with the ease of Canva.
## Table of contents
@@ -34,7 +34,7 @@ Build Python GUI's with the ease of Canva
- [Tested on](#tested-on)
- [FAQ](#faq)
- [License Information](#license-information)
- [Webbased Editor](#webbased-editor)
- [Web based Editor](#webbased-editor)
- [Electron App - Hobbyist License](#electron-app---hobbyist-license)
- [Electron App - Commercial License](#electron-app---commercial-license)
- [Some of my other open-source](#some-of-my-other-open-source)
@@ -45,6 +45,11 @@ Build Python GUI's with the ease of Canva
## Docs - Getting started
Read the docs on the [Docs page](https://pyuibuilder-docs.pages.dev/)
## 3 Easy steps.
1. Select a UI library/framework.
2. Drag and drop widgets.
3. Generate and download the code.
## Features

View File

@@ -6,7 +6,7 @@
- Simple and powerful
- Do more with plugins
- Framework independent, Generate code in multiple frameworks
- Works for multiple frameworks
[GitHub](https://github.com/PaulleDemon/PyUIBuilder)
[Get Started](#pyuibuilder-documentation)

View File

@@ -68,7 +68,7 @@ or right-click -> delete
### Resizing widgets
You can resize the widgets by dragging the widgets. If the fit-width/fit-height is set to true, make sure to uncheck it before resizing.
You can resize the widgets by dragging the widget corners. If the fit-width/fit-height is set to true, make sure to uncheck it before resizing.
### Variable names
@@ -115,6 +115,8 @@ There are 3 main layouts. The layouts are set by the parents. Once a layout is s
every child widget will use the same layout for positioning. The ony exception is if
you have enabled absolute positioning from the child widgets toolbar.
By default all layouts are set to Flex
![layouts](./assets/layouts.png)
Depending on the layout selected your child widgets will be provided with
@@ -156,10 +158,10 @@ Plugins are third party UI libraries. You can drag and drop the plugins just lik
## Exporting code
Once you are happy with the UI, you can click on export code from the header.
Once you are happy with the UI, you can click on export code from the header and code will be downloaded to your local machine.
## Requirements.txt
The requirements.txt files are auto generated, before running the code ensure you have installed the dependencies.
The requirements.txt files are auto generated, before running the code ensure you have installed the dependencies by using `pip install -r requirements.txt`
## Saving the file

View File

@@ -17,14 +17,14 @@
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap-icons/1.11.3/font/bootstrap-icons.min.css" integrity="sha512-dPXYcDub/aeb08c63jRq/k6GaKccl256JQy/AnOq7CAnEZ9FzSL9wSbcZkMp4R26vBsMLFYH4kQ67/bbV8XaCQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id="></script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LN34DDJFPS"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-');
gtag('config', 'G-LN34DDJFPS');
</script>
<!--
Notice the use of %PUBLIC_URL% in the tags above.