Commit f885bd33 authored by Romain Beurdouche's avatar Romain Beurdouche

Add note to 'doc/README.md' to insight readers to checkout the documentation...

Add note to 'doc/README.md' to insight readers to checkout the documentation at their version of the repository.
parent 75cde75f
......@@ -12,6 +12,15 @@
</tr>
</table>
This is the general overview page of the OpenAirInterface documentation.
This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries.
**IMPORTANT NOTE:**
Before reading this documentation, we strongly advise you to keep your own repository rebased on `develop`
or at least to checkout the documentation on the version of the repository you are using.
Then the documentation will better reflect the features available in your repository so that you may avoid some errors.
Beware if you previously pulled the `develop` branch that your repository may be now behind `develop`.
[[_TOC_]]
# General
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment