diff options
| author | Bin Meng <bmeng.cn@gmail.com> | 2019-01-21 22:14:16 +0800 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2019-01-22 12:17:18 +0530 |
| commit | 689c31f418f033c4051d5b6ddb76e0e3381b77d9 (patch) | |
| tree | a93c37ee03f16d8fefcd16da718fd5790d63f000 | |
| parent | 5c2ab99971dfbf9645da91e20c21f20e2648e192 (diff) | |
top: Fix broken links in top-level README.md
There are 2 markdown links that are currently broken in top-level
README.md. Fix them so that github could render the URL correctly.
This also fixes "No newline at end of file" warning.
Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
| -rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -87,7 +87,7 @@ License ------------- The software is provided under a BSD-2-Clause license. Contributions to this project are accepted under the same license with developer sign-off as -described in the [Contributing Guidelines] [docs/contributing.md]. +described in the [Contributing Guidelines](docs/contributing.md). This project also contains code from other projects as listed below. The original license text is included in those source files. @@ -109,10 +109,11 @@ as follows. * *`docs/firmware/<firmware_name>.md`* - Documentation for the firmware *<firmware_name>* The source code is also well documented. For source level documentation, -doxygen style is used. Please refer to [Doxygen manual] -(http://www.stack.nl/~dimitri/doxygen/manual.html) for details on this +doxygen style is used. Please refer to [Doxygen manual] for details on this format. +[Doxygen manual]: http://www.stack.nl/~dimitri/doxygen/manual.html + The Doxygen can be installed on your debian build system using following: ``` sudo apt-get install doxygen doxygen-latex doxygen-doc doxygen-gui graphviz @@ -134,4 +135,4 @@ or make I=<install_directory> install_docs ``` -**NOTE:** `refman.pdf` will be installed under `<install_directory>/docs`.
\ No newline at end of file +**NOTE:** `refman.pdf` will be installed under `<install_directory>/docs`. |