X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fgit-codeowners;a=blobdiff_plain;f=bin%2Fgit-codeowners;h=231b16bada4ced86b70ca600058f3663fc4e0b2e;hp=60e79b27bcd2a8d04b67ca38435c6f06fe718e68;hb=4b38ff1cb75d9b45d6620842ceb63b3ef6f62b4f;hpb=e3541feec258bc63e2cf5ac387e264816a4bf278 diff --git a/bin/git-codeowners b/bin/git-codeowners index 60e79b2..231b16b 100755 --- a/bin/git-codeowners +++ b/bin/git-codeowners @@ -19,12 +19,35 @@ =head1 DESCRIPTION -F is yet another CLI tool for managing F files in -git repos. In particular, it can be used to quickly find out who owns -a particular file in a monorepo (or monolith). +F is yet another CLI tool for managing F files in git repos. In +particular, it can be used to quickly find out who owns a particular file in a monorepo (or +monolith). -B The interface of this tool and its modules will -probably change as I field test some things. Feedback welcome. +B The interface of this tool and its modules will probably change as I field +test some things. Feedback welcome. + +=head1 INSTALL + +There are several ways to install F to your system. + +=head2 from CPAN + +You can install F using L: + + cpanm App::Codeowners + +=head2 from GitHub + +You can also choose to download F as a self-contained executable: + + curl -OL https://raw.githubusercontent.com/chazmcgarvey/git-codeowners/solo/git-codeowners + chmod +x git-codeowners + +To hack on the code, clone the repo instead: + + git clone https://github.com/chazmcgarvey/git-codeowners.git + cd git-codeowners + make bootstrap # installs dependencies; requires cpanm =head1 OPTIONS