diff options
| author | Gerald Combs <gerald@wireshark.org> | 2017-08-11 12:43:48 -0700 |
|---|---|---|
| committer | Anders Broman <a.broman58@gmail.com> | 2017-08-15 14:48:29 +0000 |
| commit | 719adb4fdc61e5187efefdfeb25a41d60d40be7f (patch) | |
| tree | 5fa55129c5dd026b006e5ea58256b8278c484843 /doc | |
| parent | f4ca61220aa65e42d880c947ce9c01dfe5bc8d4b (diff) | |
Convert README to README.md.
Convert the contents of the top-level README to Markdown and give it a
.md extension. Most of our documentation is plain text or AsciiDoc, but
the top-level README file in a Git repository is special in that many
online browsers will show the README contents along with the directory
listing and those browsers tend to favor Markdown. This is true of
GitHub (which we're currently mirroring to), Gerrit via its Gitiles
plugin (which we're not yet using but likely will), and other places.
Add "foreign" to AM_INIT_AUTOMAKE. There is probably a joke to be
made here about the FSF and border walls.
Change-Id: I87c306d74864e1f0a432225b160a1b4483ee946c
Reviewed-on: https://code.wireshark.org/review/23049
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.developer | 8 | ||||
| -rw-r--r-- | doc/README.dissector | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/doc/README.developer b/doc/README.developer index aa375db636..766ef56035 100644 --- a/doc/README.developer +++ b/doc/README.developer @@ -17,10 +17,10 @@ Before starting to develop a new dissector, a "running" Wireshark build environment is required - there's no such thing as a standalone "dissector build toolkit". -How to setup such an environment is platform dependent; detailed information -about these steps can be found in the "Developer's Guide" (available from: -https://www.wireshark.org) and in the INSTALL and README files of the sources -root dir. +How to setup such an environment is platform dependent; detailed +information about these steps can be found in the "Developer's Guide" +(available from: https://www.wireshark.org) and in the INSTALL and +README.md files of the sources root dir. 0.1. General README files. diff --git a/doc/README.dissector b/doc/README.dissector index 514fe70f7f..737848d8f1 100644 --- a/doc/README.dissector +++ b/doc/README.dissector @@ -16,10 +16,10 @@ Before starting to develop a new dissector, a "running" Wireshark build environment is required - there's no such thing as a standalone "dissector build toolkit". -How to setup such an environment is platform dependent; detailed information -about these steps can be found in the "Developer's Guide" (available from: -https://www.wireshark.org) and in the INSTALL and README files of the sources -root dir. +How to setup such an environment is platform dependent; detailed +information about these steps can be found in the "Developer's Guide" +(available from: https://www.wireshark.org) and in the INSTALL and +README.md files of the sources root dir. 0.1. Dissector related README files. |