summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Carr <[email protected]>2025-07-21 13:00:11 -0500
committerJeff Carr <[email protected]>2025-07-21 13:00:11 -0500
commit8c25ed19a3550ad49f110fa503c5d91bcb05105f (patch)
treed899ce4b2612909d6fe728baba1a66154b0e2698
parent2c27181bb51dd7632f7bb5af92d57c3e5eea8961 (diff)
doc reformat
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index f48a64d..1403539 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,23 @@
# forge
-## Design Goals
+forge is a GUI front end for 'git' designed with the
+intent of simplifying federated git development.
+
+## Theory
* Software engineering is the art of making things work.
* Release engineering is the art of making things perfect.
+## Rules
+
+1) forge is only a GUI and wrapper around 'git'
+2) forge _only_ os.Exec()'s git. Anything forge does
+ can be done on the command line using 'git' directly
+3) forge's default behavior is to use 3 branches:
+ a) The git upstream master/main branch
+ b) A "devel" branch that is published
+ c) a "user" branch that can be local only to the developer
+
## Notes
This can be used to maintain git repositories