diff options
| -rw-r--r-- | README | 69 | ||||
| -rw-r--r-- | README.md | 58 |
2 files changed, 69 insertions, 58 deletions
@@ -0,0 +1,69 @@ + _ _ __ __ + __ _(_) |_ _ / /__ ___ _ __ __ _ _ _\ \ + / _` | | __(_) / __|/ _ \| '_ \ / _` | '__| | + | (_| | | |_ _| \__ \ (_) | | | | (_| | | | | + \__, |_|\__(_) |___/\___/|_| |_|\__,_|_| | | + |___/ \_\ /_/ + +git-sonar is a shell prompt git status indicator, add it to your $PS1 prompt to +see real-time information about the current directory's repository, branch, +changed files, etc. git-sonar is forked from the original project git-radar by +Michael Allen, which is no longer receiving maintenance. +Ref: https://github.com/michaeldfallen/git-radar + +git-sonar also provides git-precheck, a shell utility script which inspects a +repository and returns machine-parseable results not easily gathered from +git status. It is intended for use in other git-related scripts. + + +INSTALLATION +------------ +For a normal installation, run 'make install', but see the output from 'make' +for more installation options. You can run 'git-sonar --version' to confirm +that the install was successful. + + +GETTING STARTED +--------------- +Both of the scripts have an accompanying man-page, which can be viewed after +installation using the 'man' command, or by passing '--help' to either script +directly. + +These are the user-facing documentation and contain more details about usage, +configuration, and inserting git-sonar into your particular shell's prompt. + +Out of the box, git-sonar has a very usable default configuration, and most +features are enabled. One can be up and running by just updating their $PS1 +variable - but see the "USAGE" section of git-sonar's man-page for some possible +$PS1 pitfalls. + + +GETTING SUPPORT +--------------- +Get in touch on the mailing list to ask questions, report problems, submit +patches, or discuss the project! + + git-sonar@normalmode.org + +For more information, or instructions on subscribing, send an email to: + + git-sonar+help@normalmode.org + + +COMPATIBILITY WITH GIT-RADAR +---------------------------- +git-sonar is no longer a "drop in" replacement for git-radar. All of the +environment variables used for configuration have been either renamed, or +removed, and several others have been added. git-sonar does not read from any +special RC files, just the shell environment. Furthermore, both tools support +different command line options. + +git-sonar does preserve the original hallmark features of git-radar, and its +default appearance is very faithful to the original as well. + + +LICENSE +------- +For historical reasons, git-sonar, git-precheck, and associated documentation +are made available under the MIT license - the same license utilized by +git-radar. 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. |