From 0b3b366635307b18bf2216032bfdeba496760428 Mon Sep 17 00:00:00 2001 From: BanceDev Date: Sat, 28 Feb 2026 15:03:07 -0500 Subject: public facing readme --- README.md | 60 ++++++++++++++++++++++-------------------------------------- TODO | 9 ++++----- logo.png | Bin 0 -> 4017 bytes 3 files changed, 26 insertions(+), 43 deletions(-) create mode 100644 logo.png diff --git a/README.md b/README.md index d61d002..98742bb 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,30 @@ -# Package Manager +

+ +
+ contributors + license + forks +

-## Usage +--- -forge add +# 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 = -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 +``` diff --git a/TODO b/TODO index 1660a35..950c04d 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,4 @@ -branch in config -hash in config -Add config command to set forge's values like the editor -Implement Search -make helper function for collecting package info +repo branch in config +repo set hash +tagged and none update modes +lockfile for update tracking diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..aeb5c6a Binary files /dev/null and b/logo.png differ -- cgit v1.2.3-59-g8ed1b