diff --git a/README b/README.md similarity index 78% rename from README rename to README.md index 6a8f0ea..6f45e26 100644 --- a/README +++ b/README.md @@ -1,14 +1,16 @@ +# OEMCrypto + This is the OEMCrypto git repository. It is visible to Widevine partners, and contains documentation for OEMCrypto, -as well as unit tests and reference code. +as well as unit tests and reference code. Several versions of OEMCrypto are available on different branches. This is the only file on the master branch. Please use the git checkout command to work with the correct version of OEMCrypto, for example, to see version 13, use the -command "git checkout origin/v13". +command `git checkout origin/v13`. -Use "git branch -a" to see a list of all branches. +Use `git branch -a` to see a list of all branches. Contact your Widevine TAM if you are unsure which branch you should use. The latest branch might have documentation without complete unit tests or sample