aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md60
-rw-r--r--TODO9
-rw-r--r--logo.pngbin0 -> 4017 bytes
3 files changed, 26 insertions, 43 deletions
diff --git a/README.md b/README.md
index d61d002..98742bb 100644
--- a/README.md
+++ b/README.md
@@ -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
+```
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
--- /dev/null
+++ b/logo.png
Binary files differ
;follow=1'>added output redirection withGravatar BanceDev 1-12/+52 2024-09-25added ; chaining operatorGravatar BanceDev 1-14/+14 2024-09-25added || chaining operatorGravatar BanceDev 1-2/+9 2024-09-25Update README.mdGravatar Lance Borden 1-0/+3 2024-09-23fixed lua api exit status issueGravatar BanceDev 1-1/+1 2024-09-23fixed splitting within quoted stringGravatar BanceDev 1-5/+10 2024-09-23made and operator actually conditionalGravatar BanceDev 2-17/+27 2024-09-23fixed operator chaining to handle commands terminating with an operatorGravatar BanceDev 1-14/+5 2024-09-23implemented background process operatorGravatar BanceDev 6-154/+238 2024-09-23implemented piping into new chaining methodGravatar BanceDev 1-10/+30 2024-09-18fixed && chaining for builtinsGravatar BanceDev 2-23/+31 2024-09-18added basic && chainingGravatar BanceDev 2-8/+73 2024-09-17changed tokenizer to handle all the chaining operatorsGravatar BanceDev 3-20/+78 2024-09-17Update README.mdGravatar Lance Borden 1-0/+1 2024-09-13added better clarification to help menuGravatar BanceDev 1-1/+2 2024-09-13improved installation instructionsGravatar BanceDev 1-3/+3 2024-09-12v0.1.1Gravatar BanceDev 1-1/+1 2024-09-12fixed bug in input buffer handling due to misplaced printGravatar BanceDev 2-5/+8 2024-09-12Update build.yml checkout v4Gravatar Lance Borden 1-1/+1 2024-09-12Update build.yml to artifact v4Gravatar Lance Borden 1-1/+1 2024-09-12fixed exit status issue with non interative modeGravatar BanceDev 1-1/+1 2024-09-12added non interative mode for running lua scriptsGravatar BanceDev 2-4/+28 2024-09-12temporary github action fix until non-interactive mode is implementedGravatar BanceDev 1-2/+2 2024-09-12attempt to update build script to accept input into lush shellGravatar BanceDev 2-4/+6 2024-09-12prevent lush workflow from getting stuck in testsGravatar Lance Borden 1-1/+4 2024-09-12removed chsh in workflowGravatar Lance Borden 1-4/+1