From 8c25ed19a3550ad49f110fa503c5d91bcb05105f Mon Sep 17 00:00:00 2001 From: Jeff Carr Date: Mon, 21 Jul 2025 13:00:11 -0500 Subject: [PATCH] doc reformat --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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