From 759155aeddb7fd64dbcadb27c0039958bd59b50e Mon Sep 17 00:00:00 2001 From: Karl Heitmann Date: Thu, 15 Jun 2023 22:29:39 -0400 Subject: [PATCH] Adds instructions on README.md to use the git-graph.toml config file --- README.md | 7 +++++++ git-graph.toml.sample | 1 + 2 files changed, 8 insertions(+) create mode 100644 git-graph.toml.sample diff --git a/README.md b/README.md index 53d77f8..42fe9b2 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,13 @@ git-graph --help For **styles** and commit **formatting**, see the [manual](docs/manual.md). +## Config file + +There is a sample `git-graph.toml.sample` file provided in this repository containing the default configuration +for `git-graph`. + +Copy and paste the file on yout `.git/` folder, change its name to `.git/git-graph.toml` and tweak it to fit your needs + ## Custom branching models Branching models are configured using the files in `APP_DATA/git-graph/models`. diff --git a/git-graph.toml.sample b/git-graph.toml.sample new file mode 100644 index 0000000..bc505c3 --- /dev/null +++ b/git-graph.toml.sample @@ -0,0 +1 @@ +model="git-flow"