updated readme

This commit is contained in:
paul
2025-04-10 17:39:07 +05:30
parent aa95ec219d
commit 37369af369
2 changed files with 24 additions and 3 deletions

View File

@@ -1,12 +1,14 @@
## Contributing
Currently if you find bugs or typos, I request you to create an issue first, instead of a Pull request.
Currently if you find bugs or typos, Please create an issue first, instead of a Pull request.
That is the best way to contribute to this repo in it's current state.
I may not get time to review every pull request, unless you are bringing in significant improvement that would have probably taken me weeks to do it myself, I may not be able to take time out of development to review it and don't take closing pull request personally. It's just that I currently don't have time.
**The repo will be going through drastic changes including migrations to TS.**
So any changes you bring may have to be rewritten. Plus, I may not get time to review every pull request, unless you are bringing in significant improvement that would have probably taken me weeks to do it myself, I may not be able to take time out of development to review it, and don't take closing pull request personally. It's just that I currently don't have time.
Thank you for understanding.
## Other ways to contribute.
## Other Best ways to contribute.
1. Creating tutorials and helping others on [discord server](https://discord.gg/dHXjrrCA7G)
2. Sharing the tool with others.

View File

@@ -47,6 +47,7 @@ Try [PyUIBuilder](https://pyuibuilder.com)
- [Web based Editor](#webbased-editor)
- [Electron App - Hobbyist License](#electron-app---hobbyist-license)
- [Electron App - Commercial License](#electron-app---commercial-license)
- [Contributing](#contributing)
- [Some of my other open-source](#some-of-my-other-open-source)
- [Author](#author)
@@ -224,6 +225,24 @@ This is meant for students and hobbyist
This is meant for business usecases, you can use the code even for commercial use.
* All code generated by the builder tools are free to use for commercial and non-commercial purposes. If you are using this for a startup or your business you'll need to get a commercial license.
## Contributing
To run it locally you'll need to add .env-cmdrc.json with the following in it. This file should be in the root directory
```json
{
"development":{
"REACT_APP_ANALYTICS_SCRIPT_ID": ""
},
"production":{
"REACT_APP_ANALYTICS_SCRIPT_ID": ""
}
}
```
For contributing read [here](./CONTRIBUTING.md)
## Some of my other open-source