summaryrefslogtreecommitdiffstats
path: root/README.md (unfollow)
AgeCommit message (Collapse)AuthorFilesLines
3 daysReplace README with new project informationMatt Hunter1-58/+0
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>
3 daysUpdate core documentation as git-sonar manpageMatt Hunter1-451/+1
The bulk of README.md is reworked, updated for accuracy, and reformatted into git-sonar(1). The output of 'git-sonar --help' is removed as well (melded into the new manpage). Now, specifying --help causes the manpage itself to open. Since 'git-sonar --help' used to be the only way to ask which version of the script is installed, a --version output is added as a terse replacement. The makefile is updated to facilitate installation of this new documentation. Signed-off-by: Matt Hunter <m@lfurio.us>
2026-02-22Remove shell-specific options from README examplesMatt Hunter1-21/+7
The --bash/--zsh/--fish options were converted to no-op command line flags a while back, since their behavior in git-sonar is identical. They are merely still recognized for compatibility with git-radar. This being the case, don't recommend their use in git-sonar's README file. Signed-off-by: Matt Hunter <m@lfurio.us>
2021-08-24Update README for new releaseMalfurious1-74/+18
Signed-off-by: Malfurious <m@lfurio.us>
2021-03-24Update references to project name to git-sonarMalfurious1-20/+20
Signed-off-by: Malfurious <m@lfurio.us>
2016-10-24Add lightweight version to READMEbogem1-0/+5
2016-04-24Merge remote-tracking branch 'upstream/master' into hotfix/unittestsClaudio Bandera1-1/+21
2016-01-05Remove the '\n' that put the cursor on a new line (prompt on 2 lines instead ↵P.Kernevez1-1/+1
of one)
2015-10-18Custom Fetch time now uses a variableSteven Hall1-5/+15
Set the variable GIT_RADAR_FETCH_TIME in a bashrc, zshrc or gitradarrc file to customize the fetch time.
2015-10-16Update README and include stash in customisation optionsMichael Allen1-0/+3
2015-10-15Updated readme with --fetch_t feature.Steven Hall1-0/+10
2015-10-15Fix typo on GIT_RADAR_FORMAT examples #65Iñaki Abete1-2/+2
2015-10-15Some readme to show how to use the format stringMichael Allen1-12/+55
2015-10-07Add missing character in Fish snippetScott Stevenson1-1/+1
2015-09-17Added documentation for stash feature.Claudio Bandera1-0/+19
2015-09-04Adding new readme stuff to the table of contentsMichael Allen1-0/+18
2015-09-04Readme to describe the colour configMichael Allen1-0/+268
2015-09-02Add manually installation instructionsjoaoschaab1-1/+8
2015-08-30Describe how to ensure proper execution of the promptMichael Allen1-7/+31
2015-08-28Removing --minimal arg implementationReinaldo Colina1-15/+0
- Dealing with the git: prefix will be done in a separate pull request - The new --no-remote-status arg remains
2015-08-28Add usage for fish to READMEbogem1-0/+13
2015-08-27issue-17: Add arguments to make the prompt shorterReinaldo Colina1-0/+28
2015-08-26Update docs to mention escaping the executionMichael Allen1-2/+4
2015-08-25Expand the readme slightlyMichael Allen1-3/+8
2015-08-25Small rewordMichael Allen1-1/+1
2015-08-25Move to git-radar repo nameMichael Allen1-12/+12
2015-08-25Nice little message about whyMichael Allen1-0/+4
2015-08-25Add example to the top of the pageMichael Allen1-0/+3
2015-08-25Link to images in readmeMichael Allen1-0/+10
2015-08-25Testing the images in the readmeMichael Allen1-0/+1
2015-08-25Fix the table formattingMichael Allen1-15/+13
2015-08-25Added readme and licenseMichael Allen1-0/+122