Change README to markdown

This commit is contained in:
Eric Torres 2024-08-06 04:27:14 -07:00
parent 289c9aebee
commit 16e1a8c9a6
2 changed files with 43 additions and 36 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# Packaging Scripts
## The Scripts
- addpkg - add a package to a repository and then automatically move
its package tarfiles to that repository\'s respective cache
directory
- delpkg - remove a package from a repository by manipulating the db
file, and then remove that respective package\'s tarballs in that
repository\'s directory
- fqo (\"fuzzy pacman -Qo\") - using fzf and mlocate, select a file
and then pass that file to \$(pacman -Qo)
- pug2 - upload a gist of explicitly installed pacman packages
### addpkg
- Either take all pacman package files in the current working
directory or from the command line and add them to the given
repository
- Automatically move said package files to the repository\'s cache
directory
### delpkg
- Take the names of packages and a repository, then delete those
packages from said repository
- Automatically delete all tarfiles of those packages from the
repository
### fqo
- Given a query, pass to locate and then pass the results to fzf
- Select a file and then pass that file to pacman -Qo
### pug2
- Automatically update a gist containing explicitly installed pacman
packages on the system
- Script inspired by ventto/pug
## Implementation Notes
- All code internally uses pathlib for path handling

View File

@ -1,36 +0,0 @@
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
Packaging Scripts
=================
The Scripts
-----------
* addpkg - add a package to a repository and then automatically move its package tarfiles to that repository's respective cache directory
* delpkg - remove a package from a repository by manipulating the db file, and then remove that respective package's tarballs in that repository's directory
* fqo ("fuzzy pacman -Qo") - using fzf and mlocate, select a file and then pass that file to $(pacman -Qo)
* pug2 - upload a gist of explicitly installed pacman packages
addpkg
^^^^^^
* Either take all pacman package files in the current working directory or from the command line and add them to the given repository
* Automatically move said package files to the repository's cache directory
delpkg
^^^^^^
* Take the names of packages and a repository, then delete those packages from said repository
* Automatically delete all tarfiles of those packages from the repository
fqo
^^^
* Given a query, pass to locate and then pass the results to fzf
* Select a file and then pass that file to pacman -Qo
pug2
^^^^
* Automatically update a gist containing explicitly installed pacman packages on the system
* Script inspired by ventto/pug
Implementation Notes
--------------------
* All code internally uses pathlib for path handling