diff --git a/README.md b/README.md new file mode 100644 index 0000000..3df2955 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +## BirdyNet +A lightweight modular browser based on Python and Qt, soon to have its own HTML and CSS interpreter. + +**Note:** The logo of this project is based on the [bird ref sheet](https://www.furaffinity.net/view/23640147/) created by [Lainn](https://www.furaffinity.net/user/lainn/) - If you use this logo, make sure to credit them. + +## Prerequisites +> #### 🌟 Python 3.4.4 or newer (older versions may work, but aren't tested) +> **Windows:** [Download](https://www.python.org/downloads/) +> **Debian:** `apt-get install python3` +_**Note:** Windows 7 support was dropped with Python 3.9 (Thanks, asshats), use Python 3.8.x, on 7._ + +> #### 🌟 QtPy +> **Windows:** `py -m pip install QtPy` +> **Debian:** `apt-get install python3-qtpy` + +> #### 🌟 A Qt library compatible with QtPy +> There is multiple choices, QtPy is compatible with PyQt5, PyQt4, PySide2 and PySide. Don't know what to choose? You probably want PyQt5: +> **Windows:** `py -m pip install PyQt5` +> **Debian:** `apt-get install python3-pyqt5` \ No newline at end of file diff --git a/readme.md b/readme.md deleted file mode 100644 index b4348a4..0000000 --- a/readme.md +++ /dev/null @@ -1 +0,0 @@ -**Note:** The logo of this project is based on the bird ref sheet created by Lainn: https://www.furaffinity.net/view/23640147/ - If you use this logo, make sure to credit them. \ No newline at end of file