summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Hunter <m@lfurio.us>2026-05-31 06:43:34 -0400
committerMatt Hunter <m@lfurio.us>2026-05-31 22:28:36 -0400
commit63e0d7677201e4f175742c0a51edbac9c81abf96 (patch)
tree802b70f4dadafc0a1565aa7a4d793e4ec60809c1 /README.md
parent2a1fa5ff11b9b3137a402ede0cd47a2754c9facf (diff)
downloadgit-sonar-63e0d7677201e4f175742c0a51edbac9c81abf96.tar.gz
git-sonar-63e0d7677201e4f175742c0a51edbac9c81abf96.zip
Replace README with new project information
With the script usage documentation now housed in their own manpages and easily recallable by the user, update the main project README and treat it as a place for higher-level project information, as opposed to detailed documentation. The old installation instructions are carried forward, since one would need to perform them to gain proper access to the rest of the resources. A project-specific mailing list has been established and is pointed to from the "GETTING SUPPORT" section. This is a good next step, but this section is in need of some additional instruction still. As the upcoming release will be the first to break _major_ configuration compatibility with git-radar, a section is added detailing the differences at a very high level. Signed-off-by: Matt Hunter <m@lfurio.us>
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 0 insertions, 58 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index e58d2cc..0000000
--- a/README.md
+++ /dev/null
@@ -1,58 +0,0 @@
-# Git Sonar
-
-A heads up display for git. Fork of 'git-radar' by Michael Allen (https://github.com/michaeldfallen/git-radar).
-
-![An example of git-sonar]
-
-## Installation
-
-For a normal installation, run 'make install' (may require sudo), but see the
-output from 'make' for more installation options. Run 'git-sonar -h' to confirm
-the install is successful.
-
-## Support
-
-### Colour Codes
-
-Colour codes make use of the colours your terminal app claims to be `red`
-or `green`. Using one of these codes will only produce the colour your terminal
-claims, so you should customise your colour scheme on your terminal as well as
-customising git-sonar.
-
-Note the "Bright" colours can be shown as bold instead, it depends on your
-terminal. By default, for example, the Mac OSX Terminal.app uses the "Bright"
-colours to provide 8 new lighter colours but some terminals only support 8 and
-will show the text as bold instead.
-
-Colour | Code for Text | Code for Background
---------------|----------------|--------------------
-Black | `\\033[0;30m` | `\\033[0;40m`
-Red | `\\033[0;31m` | `\\033[0;41m`
-Green | `\\033[0;32m` | `\\033[0;42m`
-Yellow | `\\033[0;33m` | `\\033[0;43m`
-Blue | `\\033[0;34m` | `\\033[0;44m`
-Magenta | `\\033[0;35m` | `\\033[0;45m`
-Cyan | `\\033[0;36m` | `\\033[0;46m`
-White | `\\033[0;37m` | `\\033[0;47m`
-Bright Black | `\\033[1;30m` | `\\033[1;40m`
-Bright Red | `\\033[1;31m` | `\\033[1;41m`
-Bright Green | `\\033[1;32m` | `\\033[1;42m`
-Bright Yellow | `\\033[1;33m` | `\\033[1;43m`
-Bright Blue | `\\033[1;34m` | `\\033[1;44m`
-Bright Magenta| `\\033[1;35m` | `\\033[1;45m`
-Bright Cyan | `\\033[1;36m` | `\\033[1;46m`
-Bright White | `\\033[1;37m` | `\\033[1;47m`
-Reset | `\\033[0m` | `\\033[0m`
-
-Note the Reset will set back to what your terminal claims as standard text and
-background.
-
-## License
-
-Git Radar and Git Sonar are licensed under the MIT license.
-
-See [LICENSE] for the full license text.
-
-## Links
-
-* [mini-git-radar](https://github.com/bogem/mini-git-radar) - lightweight version of git-radar. Only for macOS and bash/fish.