Skip to content

Commit

Permalink
meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
gamemaker1 committed Jun 16, 2021
1 parent 6e7409c commit dfc83a6
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
File renamed without changes
2 changes: 1 addition & 1 deletion install → assets/package/install
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ fi
printg " ==> Starting build process..."

# The build dir is the same as if we were installing yeet using yeet
# Clear the build dir (in case it already exists
# Clear the build dir (in case it already exists)
rm -rf "${XDG_CACHE_HOME:-$HOME/.cache}/yeet/build/yeet/"
# Create it again
mkdir -p "${XDG_CACHE_HOME:-$HOME/.cache}/yeet/build/yeet/"
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# YEET

Yet another minimalistic [pacman](https://wiki.archlinux.org/title/Pacman) wrapper. Yeet!
Yet another minimal [pacman](https://wiki.archlinux.org/title/Pacman) wrapper. Yeet!

Inspired by several AMAZING projects: [`pacaur`](https://aur.archlinux.org/pacaur), [`pikaur`](https://aur.archlinux.org/pikaur), [`yay`](https://aur.archlinux.org/yay) and [`paru`](https://aur.archlinux.org/paru). Uses [`package-query`](https://aur.archlinux.org/package-query) to query packages from the sync repos and AUR.

## Preview

![[Yeet being used](./preview.png)](./preview.png)
![[Yeet being used](./assets/media/preview.png)](./assets/media/preview.png)

## Installation

Expand All @@ -21,13 +21,13 @@ The script will perform the steps given in the [Manual Installation section](#ma
Using `cURL`:

```
curl https://raw.githubusercontent.com/gamemaker1/yeet/develop/install | bash
curl https://raw.githubusercontent.com/gamemaker1/yeet/develop/assets/package/install | bash
```

Using `wget`:

```
wget https://raw.githubusercontent.com/gamemaker1/yeet/develop/install -O - | bash
wget https://raw.githubusercontent.com/gamemaker1/yeet/develop/assets/package/install -O - | bash
```

### Manual
Expand All @@ -44,7 +44,7 @@ mkdir -p ~/.cache/yeet/build/
cd ~/.cache/yeet/build/
git clone https://aur.archlinux.org/yeet.git
cd yeet
makepkg -sic
makepkg -sfcCi
```

## Usage and configuration
Expand All @@ -58,19 +58,19 @@ makepkg -sic
- Upgrade all packages (`yeet -U`)
- Run pacman -Q (`yeet -Q`)

`yeet` can be configured using its config file, located at `$XDG_CONFIG_HOME/yeet/yeet.conf` OR `$HOME/.config/yeet/yeet.conf`. [Here](./yeet.example.conf) is an example configuration.
`yeet` can be configured using its config file, located at `$XDG_CONFIG_HOME/yeet/yeet.conf` OR `$HOME/.config/yeet/yeet.conf`. [Here](./assets/package/yeet.example.conf) is an example configuration.

## Contributing

Thank you for your interest in contributing to `yeet`!

You can contribute to `yeet` by spreading the word, spotting and fixing bugs, and help adding new features. `yeet` is just a bash script, you may edit [the file](./yeet) and submit a pull request. Suggestions and PRs welcome!
You can contribute to `yeet` by spreading the word, spotting and fixing bugs, and help adding new features. `yeet` is just a bash script, you may edit [the file](./source/yeet) and submit a pull request. Suggestions and PRs welcome!

## License

### GNU GPL v3

Copyright (C) 2021 Vedant K (gamemaker1) \<gamemaker0042@gmail.com\>
Copyright (C) 2021 Vedant K (gamemaker1) \<gamemaker0042 at gmail dot com\>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
File renamed without changes.

0 comments on commit dfc83a6

Please sign in to comment.