kopia lustrzana https://github.com/biobootloader/wolverine
Update README.md
- made the GPT-4 warning more destinct - added licence, workflow buttons (should be added in the workflow sections) - added symbols - changed title from ## about to ## Why you need this?pull/26/head
rodzic
2f5a026ff9
commit
c62643e4ac
26
README.md
26
README.md
|
@ -1,14 +1,18 @@
|
|||
# Wolverine
|
||||
|
||||
## About
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://twitter.com/bio_bootloader) [](https://pepy.tech/project/wolverine)
|
||||
|
||||
## 🤔 Why you need this?
|
||||
|
||||
Give your python scripts regenerative healing abilities!
|
||||
|
||||
Run your scripts with Wolverine and when they crash, GPT-4 edits them and explains what went wrong. Even if you have many bugs it will repeatedly rerun until it's fixed.
|
||||
|
||||
## 🎬 Demonstration
|
||||
For a quick demonstration see my [demo video on twitter](https://twitter.com/bio_bootloader/status/1636880208304431104).
|
||||
|
||||
## Setup
|
||||
## 🛠️ Setup
|
||||
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
|
@ -17,9 +21,13 @@ For a quick demonstration see my [demo video on twitter](https://twitter.com/bio
|
|||
|
||||
Add your openAI api key to `.env`
|
||||
|
||||
_warning!_ By default wolverine uses GPT-4 and may make many repeated calls to the api.
|
||||
> :warning: **WARNING** GPT-4 token usage
|
||||
>
|
||||
> By default wolverine uses GPT-4 and may make many repeated calls to the api.
|
||||
>
|
||||
> :warning: **WARNING** GPT-4 token usage
|
||||
|
||||
## Example Usage
|
||||
## 📝 Example Usage
|
||||
|
||||
To run with gpt-4 (the default, tested option):
|
||||
|
||||
|
@ -37,7 +45,7 @@ You can also use flag `--confirm=True` which will ask you `yes or no` before mak
|
|||
|
||||
python wolverine.py buggy_script.py "subtract" 20 3 --confirm=True
|
||||
|
||||
## Future Plans
|
||||
## 🔮 Future Plans
|
||||
|
||||
This is just a quick prototype I threw together in a few hours. There are many possible extensions and contributions are welcome:
|
||||
|
||||
|
@ -48,6 +56,12 @@ This is just a quick prototype I threw together in a few hours. There are many p
|
|||
- graceful handling of large files - should we just send GPT relevant classes / functions?
|
||||
- extension to languages other than python
|
||||
|
||||
## Star History
|
||||
## 🌟 History
|
||||
|
||||
[](https://star-history.com/#biobootloader/wolverine)
|
||||
|
||||
## 💁 Contributing
|
||||
|
||||
As an open source project in a rapidly developing field, I am open to contributions, whether it be in the form of a new feature, improved infra, or better documentation.
|
||||
|
||||
For detailed information on how to [contribute](.github/CONTRIBUTING.md).
|
||||
|
|
Ładowanie…
Reference in New Issue