summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSzczepan Zalega <szczepan.zalega@gmail.com>2016-04-13 22:53:23 +0200
committerSzczepan Zalega <szczepan.zalega@gmail.com>2016-04-13 22:53:23 +0200
commit1778e7de61db4ac75b07b998e625197a40986ca2 (patch)
treeed94baf1376111da1e9d222b04aff27394127804 /README.md
parent92b929f86dc1d1712f515c164e5e77ad21ad8ff6 (diff)
downloadlibnitrokey-1778e7de61db4ac75b07b998e625197a40986ca2.tar.gz
libnitrokey-1778e7de61db4ac75b07b998e625197a40986ca2.tar.bz2
Update Readme: cloning recursively with git
Signed-off-by: Szczepan Zalega <szczepan.zalega@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 89d7c46..1cc42ad 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,17 @@
Warning! Before you run unittests please either change both your Admin and User PINs on your Nitrostick to defaults (12345678 and 123456 respectively) or change the values in tests source code. If its too late, you can always reset your Nitrokey using instructions from [homepage](
https://www.nitrokey.com/de/documentation/how-reset-nitrokey).
+To clone please use git's --recursive option like in:
+```bash
+git clone --recursive https://github.com/Nitrokey/libnitrokey.git
+```
+or for already cloned repository:
+```bash
+git clone https://github.com/Nitrokey/libnitrokey.git
+cd libnitrokey
+git submodule update --init --recursive
+```
+
Libnitrokey do not have at the moment any documentation. Most helpful for
now would be unittests [currently hotp_tests branch - still in
development, but they should show how to handle operations with Nitrokeys and