Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yossTheDev committed Jul 9, 2023
1 parent fdfa372 commit bbeb0d8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 11 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
<h1 align="center">yala</h1>

![screenshot](/img/banner.png)
<p align="center"> The most prettier 📦 Package Manager for <b>Arch Linux</b> and <b>Derivates</b></p>
<p align="center"> The Most Prettier, TUI based 📦 Package Manager for <b>Arch Linux</b> and <b>Derivates</b>. Inpired by Nala</p>

<img alt="GitHub" src="https://img.shields.io/github/license/yossthedev/yala?style=for-the-badge">

```monospace
⚠️ yala is currently under development so expect drastic changes and some bugs
```

## 🚀 Features

* 🎨 Pretty outputs
* 🙂 Ease to use
* 🙂 Ease to use and intuitive commands
* 📦 Basic Commands -> Install, Search, Update, Upgrade
* 🏗️ Advanced Commands -> Inspect, more comming soon...

---

## 💡 The IDEA

The idea behind **Yala** is to create a package manager more intuitive, beautiful, and with additional features to make our life easier. Like Inspecting Packages, Advanced Logs, Unlocking Databases, Clearing Package Cache and more, some are already implemented and others are still to come.

----

## 👷‍♂️ Building From Source

First, make sure all dependencies are sucefully installed, I recommend Poetry for enviroment configuration.
First, make sure all dependencies are sucefully installed, I recommend [Poetry](https://python-poetry.org/) for enviroment configuration.

### Prepare Enviroment and Installing Dependencies

Expand All @@ -24,27 +36,33 @@ poetry install

### Building with **PyInstaller**

Tested with Python 3.11 and PyInstaller 5.13.0
Tested with **Python 3.11** and PyInstaller **5.13.0**

``` sh
bash build.sh
```

### Building with **Nuitka**

Slow compile time but best performance and small compiled size
Longer compile time but best performance and smaller compiled size. See [Nuitka Requirements](https://www.nuitka.net/doc/user-manual.html#requirements)

Installing Nuitka:

``` sh
python -m pip install nuitka
```

Tested with Python 3.11 and Nuitka 1.7
Tested with **Python 3.11** and **Nuitka 1.7**

``` sh
bash build_nuitka.sh
```

## License
## 👥 Contribution

All contributions are welcome, do not hesitate to give your comments about the developments of **Yala** or collaborate by reporting bugs or writing code. Thank you very much 😄

## ⚖️ License

---
![GPLv3](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)
Expand Down
4 changes: 0 additions & 4 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -497,10 +497,6 @@ def show_installed_packages():
)


def progress(percent, message):
typer.echo(percent)


def get_package(package: str, dbs):
for db in dbs:
pk = db.get_pkg(package)
Expand Down

0 comments on commit bbeb0d8

Please sign in to comment.