summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1e5ed17..007c188 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
# forge
+## Design Goals
+
+* Software engineering is the art of making things work.
+* Release engineering is the art of making things perfect.
+
+## Notes
+
This can be used to maintain git repositories
expiremental work on federated git
@@ -9,22 +16,25 @@ expiremental work on federated git
* uses a GUI or the console(console display needs work)
* always wrap around 'git' -- it basically just types 'git' commands really fast
-## Notes & Goals:
+## Development Goals
-* use a GUI that also works on the command line
-* andlabs GTK gui plugin starts breaking around 200 repos
+* have a GUI that also works on the command line
## Install:
* go install go.wit.com/apps/forge@latest
-## building from sources (may work Jan 2026)
+## building from sources
```
+# note as of Feb 2025. Forge has an option in forge to build itself.
+# The instructions below are out of date, but provide the general idea.
+# accurate instructions are in the forge code itself
+
go install go.wit.com/apps/go-clone@latest # this tool makes it easier to 'git clone' repos and recursively 'git clone' the dependancies
go install go.wit.com/apps/autogenpb@latest # this tool will generate the protobuf *pb.go files (also Marshal(), Sort(), etc.)
-go-clone --recursive go.wit.com/apps/forge # this will 'git clone' about 20 repos into ~/go/src (or where your go.work file is)
+go-clone go.wit.com/apps/forge # this will 'git clone' about 20 repos into ~/go/src (or where your go.work file is)
cd go.wit.com/lib/protobuf/forgepb
make # autogenpb will make .pb.go, marshal.pb.go and sort.pb.go files