diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 69 |
1 files changed, 69 insertions, 0 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. |