On Wed, 2017-03-29 at 12:42 -0700, Ben Pfaff wrote: > One or two people have expressed surprise to me that there are no > installation instructions at the top level. This should help. (The > content is copied from README.rst.) > > Signed-off-by: Ben Pfaff <[email protected]>
How odd. GitHub has taught me to always seek out the README as the starting point for any project. I figured everyone else would do the same now, though I do realize there are a lot of older (GNU) "standards" around these things... > --- > INSTALL.rst | 12 ++++++++++++ > Makefile.am | 1 + > 2 files changed, 13 insertions(+) > create mode 100644 INSTALL.rst > > diff --git a/INSTALL.rst b/INSTALL.rst > new file mode 100644 > index 000000000000..07268033188a > --- /dev/null > +++ b/INSTALL.rst > @@ -0,0 +1,12 @@ > +Installing Open vSwitch > +----------------------- > + > +To install Open vSwitch on a regular Linux or FreeBSD host, please > read the > +`installation guide <Documentation/intro/install/general.rst>`__. > > For specifics > +around installation on a specific platform, refer to one of the > `other > +installation guides <Documentation/intro/install/index.rst>`__ Should we should link to the docs website instead? Depends on whether we expect people to browse this from the web or locally, I guess. If we go with the web, you could simplify this to: To install Open vSwitch, refer to the `documentation <http://docs.openvswitch.org>` > +------- > + > [email protected] > diff --git a/Makefile.am b/Makefile.am > index c853085b9ca9..6ad50b6af391 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -67,6 +67,7 @@ EXTRA_DIST = \ > AUTHORS.rst \ > CONTRIBUTING.rst \ > MAINTAINERS.rst \ > + INSTALL.rst \ > README.rst \ > NOTICE \ > .travis.yml \ I'm OK with local links also though, so: Acked-by: Stephen Finucane <[email protected]> Stephen _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
