1
0
Fork 0
mirror of https://github.com/myned/modufur.git synced 2024-11-01 13:02:38 +00:00

Update README

This commit is contained in:
Myned 2022-02-22 17:35:24 -06:00
parent ffc14b2897
commit d3b06be694
No known key found for this signature in database
GPG key ID: 33790F979F7A28B8

View file

@ -1,8 +1,8 @@
# Modufur # Modufur
An experimental [Hikari](https://www.hikari-py.dev) Discord bot for reverse image searching using [SauceNAO](https://saucenao.com) & [Kheina](https://kheina.com) An experimental [Hikari](https://www.hikari-py.dev) Discord bot for reverse image searching using [SauceNAO](https://saucenao.com) & [Kheina](https://kheina.com)
## Optional ## Prerequisites
A Unix-based operating system is used for the following commands\ A Unix-based operating system is used for the following commands\
[WSL](https://docs.microsoft.com/en-us/windows/wsl) can be used to run Linux on Windows, but is not required [WSL](https://docs.microsoft.com/en-us/windows/wsl) can be used to run Linux on Windows, but is not required to run the bot
## Requirements ## Requirements
[Git](https://git-scm.com/downloads)\ [Git](https://git-scm.com/downloads)\
[Python](https://www.python.org) 3.10+\ [Python](https://www.python.org) 3.10+\
@ -69,7 +69,7 @@ rm -rf Modufur
``` ```
poetry run python black . poetry run python black .
``` ```
4. [Commit](https://github.com/git-guides/git-commit) them to the fork 4. [Commit](https://github.com/git-guides/git-commit) the changes to the fork
5. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) from the fork 5. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) from the fork
## FAQ ## FAQ
### What happened to the public bot? ### What happened to the public bot?