From 5b820b9db890c7b82c78d2e29109ec521fdd0bc6 Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 16 Jan 2016 10:05:32 +0900 Subject: [PATCH] core: Add note about sudo and git --- tmk_core/doc/build.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tmk_core/doc/build.md b/tmk_core/doc/build.md index 0585d62d..57a36ac4 100644 --- a/tmk_core/doc/build.md +++ b/tmk_core/doc/build.md @@ -20,7 +20,7 @@ You can find firmware source at github: - -If you are familiar with `git` tools you are recommended to use it but you can also download zip archive from: +If you are familiar with [`git`][git] tools you are recommended to use it but you can also download zip archive from: - @@ -70,7 +70,7 @@ Or you can execute the command directly as the following. $ dfu-programmer flash $ dfu-programmer reset -`` part will be `atmega32u4` or `atmega32u2` in most cases. See manual of the command for the detail. +`` part will be `atmega32u4` or `atmega32u2` in most cases. See manual of the command for the detail. On Linux and Mac OSX you will need proper permission to program a controller and you can use `sudo` command for this purpose probably. On Linux you also can configure `udev` rules to set permission. #### FLIP GUI tutorial @@ -111,6 +111,7 @@ You may want to use other programmer like [`avrdude`][avrdude]. In that case you [dfu-prog]: http://dfu-programmer.sourceforge.net/ [teensy-loader]:http://www.pjrc.com/teensy/loader.html [avrdude]: http://savannah.nongnu.org/projects/avrdude/ +[git]: https://git-scm.com/