Skip to content

Commit

Permalink
Revamped project structure.
Browse files Browse the repository at this point in the history
- Now directories are more specific.
- Using `Modules` instead of `Utilities`
- Added -t flag for testing.
- Auto update is now available.
- MODULES NEEDS TO BE PORTED.
  • Loading branch information
soymadip committed Oct 23, 2024
1 parent 86a9057 commit 44ee487
Show file tree
Hide file tree
Showing 36 changed files with 454 additions and 562 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.3.3
0.4.3
Binary file removed Assets/fonts/FiraCodeNerdFont-Retina.ttf
Binary file not shown.
Binary file removed Assets/fonts/GrapeNuts-Regular.ttf
Binary file not shown.
Binary file removed Assets/fonts/Icomoon-Feather.ttf
Binary file not shown.
Binary file removed Assets/fonts/Iosevka-Nerd-Font-Complete.ttf
Binary file not shown.
Binary file removed Assets/fonts/JetBrains-Mono-Nerd-Font-Complete.ttf
Binary file not shown.
Binary file removed Assets/meta-commnads.png
Binary file not shown.
Binary file removed Assets/welcome.gif
Binary file not shown.
55 changes: 37 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,64 @@
<h1 align="center"> 🏗 KireiSakura-Kit</h1>
<p align="center">
<img src="Assets/icon.png">
</p>
<h1 align="center">KireiSakura-Kit</h1>

KireiSakura-Kit is a library/framework based on [Bash](https://www.gnu.org/software/bash/) for making powerful shell scripts.
<p align="center">
KireiSakura-Kit is a library/framework based on <a href="https://www.gnu.org/software/bash">Bash</a> for making powerful shell scripts.
</p>

> "KireiSakuraKit" is combination of two Japanese words, "Kirei" and "Sakura," along with the suffix "Kit".
>`Kirei(綺麗)` means "clean" & `Sakura(桜)` refers to cherry blossoms. Together, "KireiSakura-Kit" could be interpreted as a library that emphasizes a beautiful and clean design inspired by the elegance of cherry blossoms.
> "KireiSakuraKit" is combination of two Japanese words, "Kirei" and "Sakura," along with the suffix "Kit".
> `Kirei(綺麗)` means "clean" & `Sakura(桜)` refers to cherry blossoms. Together, "KireiSakura-Kit" could be interpreted as a library that emphasizes a beautiful and clean design inspired by the elegance of cherry blossoms.
## Features

- **Written in purely bash**, can be used in any POSIX shell script.
- Various UI elements.
- **Mudular**, import only stuff you need.
- **Log support**, with various levels.
- **Many in-built functions**, no need to write from scratch.
- See [TODO](./TODO.md) for planned stuff.
<!-- - Various **UI elements**. -->

## Installation & setup

#### Installation:
Run below command to Install Kireisakura-Kit
> You need `curl` to be pre-installed.
```bash
curl -L https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh | bash
```
#### Setup
In your Script, include this line at the top:
- Make sure you have `curl`, `grep` installed.

- Follow below steps to Install Kireisakura-Kit

### For system wide:-

- In terminal run:-

```bash
curl -L https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh | bash -s -- -ds
```

- Then in your script, include this line at the top:-

```bash
eval "$(kireisakura --init)"
```

### Or directly in script:-

```bash
eval "$(kireisakura --init)"
if command -v kireisakura &> /dev/null; then
eval "$(kireisakura --init)"
else
echo "> Installing KireiSakura-Kit"
curl -sL https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh -o kirestaller.sh
bash kirestaller.sh
fi
```


## Methods & Docs

- Docs To be done.
- Run `kireisakura -h` for help.
- See [my dotfiles](https://github.com/soymadip/Dotfiles/blob/dotfiles/install/start.sh) for example.


## Warning

- As of now, some part of this library is Arch-linux centric, but can be extended to any distro.
- Contribute if you find this useful and wanna make this more powerful.

7 changes: 5 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Future Plans:

## For Initial Release:

- [x] Make `init.sh` in kit root for initialization.
- [x] Make setup command: `eval "$(kireisakura --init)"`
- [x] Make other commands:
- [x] Make other commands:
- `kireisakura -h`
- `kireisakura -v`
- `kireisakura -d` etc.
- [x] Make a test script.
- [x] Make install script.
- [x] Better directory structure.

## For Another Time:
- [ ] Implement Auto-Update.

- [x] Implement Auto-Update.
- [ ] Make use of log file in more functions (for more detailed logs).
- [ ] Check if core functions & dependency functions are loaded and set that script load flag true using a variable.
- [ ] Add `-q` or `--quiet` flag to all possible functions.
Expand Down
65 changes: 0 additions & 65 deletions Utilities/[EOS post install] user_commands.bash

This file was deleted.

Loading

0 comments on commit 44ee487

Please sign in to comment.