Browse Source

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>
Bin Meng 5 years ago
parent
commit
689c31f418
1 changed files with 5 additions and 4 deletions
  1. 5 4
      README.md

+ 5 - 4
README.md

@@ -87,7 +87,7 @@ License
 -------------
 -------------
 The software is provided under a BSD-2-Clause license. Contributions to this
 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
 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
 This project also contains code from other projects as listed below. The original
 license text is included in those source files.
 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>*
 * *`docs/firmware/<firmware_name>.md`* - Documentation for the firmware *<firmware_name>*
 
 
 The source code is also well documented. For source level documentation,
 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.
 format.
 
 
+[Doxygen manual]: http://www.stack.nl/~dimitri/doxygen/manual.html
+
 The Doxygen can be installed on your debian build system using following:
 The Doxygen can be installed on your debian build system using following:
 ```
 ```
 sudo apt-get install doxygen doxygen-latex doxygen-doc doxygen-gui graphviz
 sudo apt-get install doxygen doxygen-latex doxygen-doc doxygen-gui graphviz
@@ -134,4 +135,4 @@ or
 make I=<install_directory> install_docs
 make I=<install_directory> install_docs
 ```
 ```
 
 
-**NOTE:** `refman.pdf` will be installed under `<install_directory>/docs`.
+**NOTE:** `refman.pdf` will be installed under `<install_directory>/docs`.