Files
LorenEteval_Furious/README.md
T

49 lines
1.7 KiB
Markdown

# Furious
[![Build and release](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml/badge.svg?branch=main)](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml)
[![Latest release](https://img.shields.io/github/v/release/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/releases)
[![License](https://img.shields.io/github/license/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/blob/main/LICENSE)
A GUI client based on PySide6. Support Xray-core & hysteria.
## Installation
Download a packaged build from [GitHub Releases](https://github.com/LorenEteval/Furious/releases). This is the
recommended option for most users.
Windows users can also install Furious with WinGet:
```
winget install --id=LorenEteval.Furious -e
```
For a Python environment, install the `Furious-GUI` package:
```
pip install Furious-GUI
```
See [Install from PyPI](https://github.com/LorenEteval/Furious/wiki/Install-From-PyPI) for compatibility and launch
details.
## Documentation
See the [Wiki](https://github.com/LorenEteval/Furious/wiki) for complete documentation. Start with
the [Quick Start](https://github.com/LorenEteval/Furious/wiki/Quick-Start), or
consult [Troubleshooting and Diagnostics](https://github.com/LorenEteval/Furious/wiki/Troubleshooting-and-Diagnostics)
when something goes wrong.
## Contributing
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/LorenEteval/Furious)
## Credits
- [Xray-core](https://github.com/XTLS/Xray-core)
- [Hysteria](https://github.com/apernet/hysteria)
- [tun2socks](https://github.com/xjasonlyu/tun2socks)
## License
License under the [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).