|
1 |
| -# FLUX |
2 |
| -A GUI File sharing tool based on |
3 |
| -- Fast |
4 |
| -- Link |
5 |
| -- Universal |
6 |
| -- eXchange |
| 1 | +<div align="center" class="text-center"> |
| 2 | +<h1>FLUX</h1> |
| 3 | +<p><em>Securely transfer files, effortlessly and efficiently.</em></p> |
| 4 | + |
| 5 | +<img alt="last-commit" src="https://img.shields.io/github/last-commit/PythonicBoat/FLUX?style=flat&logo=git&logoColor=white&color=0080ff" class="inline-block mx-1" style="margin: 0px 2px;"> |
| 6 | +<!-- Version Tag Badge --> |
| 7 | +<img alt="version" src="https://img.shields.io/github/v/tag/PythonicBoat/FLUX?style=flat&color=0080ff" class="inline-block mx-1" style="margin: 0px 2px;"> |
| 8 | + |
| 9 | +<!-- Visitor Count Badge --> |
| 10 | +<img alt="visitors" src="https://visitor-badge.laobi.icu/badge?page_id=PythonicBoat.FLUX&style=flat&color=0080ff" class="inline-block mx-1" style="margin: 0px 2px;"> |
| 11 | + |
| 12 | +<p><em>Built with the tools and technologies:</em></p> |
| 13 | +<img alt="TOML" src="https://img.shields.io/badge/TOML-9C4121.svg?style=flat&logo=TOML&logoColor=white" class="inline-block mx-1" style="margin: 0px 2px;"> |
| 14 | +<img alt="Python" src="https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white" class="inline-block mx-1" style="margin: 0px 2px;"> |
| 15 | +</div> |
| 16 | + |
| 17 | +## Table of Contents |
| 18 | +- [Overview](#flux) |
| 19 | +- [Getting Started](#features) |
| 20 | + - [Prerequisites](#prerequisites) |
| 21 | + - [Installation](#installation) |
| 22 | + - [Usage](#usage) |
| 23 | +- [Features](#features) |
| 24 | +- [Contributing](#contributing) |
| 25 | +- [License](#license) |
| 26 | + |
| 27 | +## Overview |
| 28 | +FLUX is a powerful and secure file transfer utility tool for developers who prioritize speed and security. It is designed to be fast, lightweight, and easy to use. |
| 29 | + |
| 30 | +<ul class="list-disc pl-4 my-0"> |
| 31 | +<li class="my-0">🔒 <strong>Secure File Transfers:</strong> Ensures data integrity with encryption and compression during transfers.</li> |
| 32 | +<li class="my-0">🖥️ <strong>User-Friendly Interface:</strong> Simplifies file management with real-time progress tracking and intuitive controls.</li> |
| 33 | +<li class="my-0">🛠️ <strong>Modular Architecture:</strong> Enhances maintainability and scalability through well-defined components.</li> |
| 34 | +<li class="my-0">🌍 <strong>Cross-Platform Compatibility:</strong> Built with Python, ensuring seamless operation across various systems.</li> |
| 35 | +<li class="my-0">📜 <strong>Open Source:</strong> Licensed under MIT, fostering collaboration and innovation within the developer community.</li> |
| 36 | +</ul> |
| 37 | + |
| 38 | +### Installation |
| 39 | +Build FLUX from the source and install dependencies using the following steps: |
| 40 | + |
| 41 | +<ol> |
| 42 | +<li class="my-0"> |
| 43 | +<p><strong>Clone the repository:</strong></p> |
| 44 | +<pre><code class="language-sh">❯ git clone https://github.com/PythonicBoat/FLUX |
| 45 | +</code></pre> |
| 46 | +</li> |
| 47 | +<li class="my-0"> |
| 48 | +<p><strong>Navigate to the project directory:</strong></p> |
| 49 | +<pre><code class="language-sh">❯ cd FLUX |
| 50 | +</code></pre> |
| 51 | +</li> |
| 52 | +<li class="my-0"> |
| 53 | +<p><strong>Install the dependencies:</strong></p> |
| 54 | +</li> |
| 55 | +</ol> |
| 56 | + |
| 57 | +Using uv: |
| 58 | + |
| 59 | +```bash |
| 60 | +❯ uv init |
| 61 | +``` |
| 62 | + |
| 63 | +```bash |
| 64 | +❯ uv install |
| 65 | +``` |
| 66 | + |
| 67 | +### Usage |
| 68 | +To run FLUX, use the following command: |
| 69 | + |
| 70 | +```bash |
| 71 | +❯ uv run main.py |
| 72 | +``` |
| 73 | + |
| 74 | +### Build |
| 75 | +To build FLUX, use the following command: |
| 76 | + |
| 77 | +## |
| 78 | + uv build |
| 79 | + |
| 80 | + |
| 81 | +<div align="left" class=""><a href="#top">⬆ Return</a></div> |
0 commit comments