[Bro-Dev] [JIRA] (BIT-1413) README files misidentified by GitHub

[Vlad Grigorescu (JIRA)]

Vlad Grigorescu created BIT-1413:
------------------------------------

             Summary: README files misidentified by GitHub
                 Key: BIT-1413
                 URL: https://bro-tracker.atlassian.net/browse/BIT-1413
             Project: Bro Issue Tracker
          Issue Type: Problem
          Components: Documentation
            Reporter: Vlad Grigorescu


If a README file doesn't have an extension, GitHub will parse it as Markdown. Because our README files are ReST, this results in some ugly (and not very useful) READMEs when visiting the repository on GitHub.

For example, see: https://github.com/bro/btest#readme

There are two options we could take to fix this: rename README to README.rst, or create a symlink. I tried out the symlink option here, and I think the result is much more useful: https://github.com/grigorescu/btest#readme

The affected repos are:

binpac
bro
bro-aux
bro-plugins
bro-scripts
broccoli
broccoli-perl
broccoli-python
broccoli-ruby
broctl (broctl's README just instructs users to see doc/broctl.rst. This could just be a symlink)
broker
bromagic (this can probably be deleted?)
btest
capstats
time-machine
trace-summary




--
This message was sent by Atlassian JIRA
(v6.5-OD-05-041#65001)