doc reformat
This commit is contained in:
parent
2c27181bb5
commit
8c25ed19a3
15
README.md
15
README.md
|
@ -1,10 +1,23 @@
|
||||||
# forge
|
# 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.
|
* Software engineering is the art of making things work.
|
||||||
* Release engineering is the art of making things perfect.
|
* 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
|
## Notes
|
||||||
|
|
||||||
This can be used to maintain git repositories
|
This can be used to maintain git repositories
|
||||||
|
|
Loading…
Reference in New Issue