diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 22 insertions, 38 deletions
@@ -1,46 +1,30 @@ -# Package Manager +<p align="center"> + <img width="256" height=auto src="logo.png"> + <br/> + <img src="https://img.shields.io/github/contributors/bancedev/forge" alt="contributors"> + <img src="https://img.shields.io/github/license/bancedev/forge" alt="license"> + <img src="https://img.shields.io/github/forks/bancedev/forge" alt="forks"> +</p> -## Usage +--- -forge add <repo> +# Forge -creates a config for the package based on the repo name. +Forge is a from-source package manager that allows for the seamless tracking, installing, and updating of packages build from git repositories. Forge is entirely independent of any upstream repository project you only need a git repo with the source code. -#TODO: handle namespace conflict +Forge is mostly designed to be used alongside an operating system with existing package managers like Arch Linux or Debian Linux with forge acting as a simple tool to supplement packages that don't exist or give user freedom to use from-source compilation to optimize performance on certain applications. At this point in time forge has no concept of a dependency tree for the packages it tracks but it may at some point in the future. -config options: +--- -update = <no, live, tagged> -build = "build command" -install = "install command" -uninstall = "uninstall command" -clean = "clean command" -deps = ["named list of deps"] +## Compiling/Installation -forge update +Forge uses [just](https://github.com/casey/just) to simplify build and install. +``` +just +sudo just install +``` -pulls latest for all tracked packages per update rules - -forge upgrade [pkgnames] - -If no names are provided assume all otherwise do build and install on named packages - -forge remove [pkgnames] - -Removes named packages and orphaned deps - -forge list - -lists all packages currently tracked - -forge search [term] - -lists packages with the given substring not case sensitive - -forge clean [pkgnames] - -runs the clean command on every tracked package or named - -forge show [pkgname] - -shows the configured info about the package +Then you can bootstrap forge to track itself by doing. +``` +sudo forge add https://git.bance.dev/forge.git +``` |