Depends on the project (which those projects may/may not be doing it right).
Katello a README ( https://git.fedorahosted.org/cgit/katello.git/tree/README.md). FreeIPA and SSSD use a README ( https://git.fedorahosted.org/cgit/freeipa.git/tree/README) and BUILD.txt ( https://git.fedorahosted.org/cgit/freeipa.git/tree/BUILD.txt) Either way README and BUILD or INSTALL need to be created and/or updated in our repo. On Thu, Sep 11, 2014 at 9:57 AM, Steve Grubb <sgr...@redhat.com> wrote: > On Thursday, September 11, 2014 10:57:09 AM Greg Elin wrote: > > Is the common file "INSTALL.txt" or "BUILD.txt"? > > There is no '.txt'. There is a table on this page that states the files > that > are normally present/expected in opensource software: > > http://en.wikipedia.org/wiki/README > > So, the build instructions would normally go into INSTALL which is > expected to > live in the top level directory. > > -Steve > > > > On Wed, Sep 10, 2014 at 10:03 AM, Steve Grubb <sgr...@redhat.com> wrote: > > > On Wednesday, September 10, 2014 06:51:35 AM Greg Elin wrote: > > > > It was a fair amount of web searching and a couple of hours of > trying to > > > > work this out. It seemed a odd that the information was so scarce and > > > > I'd > > > > need install and enable EPEL and so much in order to make. I guess if > > > > > > this > > > > > > > is the case, I would have just expected more warning from SSG docs. > > > > > > Typically (or at least one following gnu standards) would have an > INSTALL > > > file > > > that describes how to build from source. > > > > > > > So I want to make sure I am actually doing this right and have a > little > > > > discussion before creating a pull request. > > > > > > Failing to find a INSTALL file, I'd just read the spec file. It clearly > > > spells > > > out the build requirements and build steps. Those should be documented > > > into an > > > INSTALL file. > > > > > > -Steve > > -- > SCAP Security Guide mailing list > scap-security-guide@lists.fedorahosted.org > https://lists.fedorahosted.org/mailman/listinfo/scap-security-guide > https://github.com/OpenSCAP/scap-security-guide/ >
-- SCAP Security Guide mailing list scap-security-guide@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/scap-security-guide https://github.com/OpenSCAP/scap-security-guide/
