Documentation Improvements about controller

[haata]

Sure! Help is always welcome :D
Smasher has been helping move the readme to the wiki, but it would be nice to have more detailed/straightforward instructions.

It would be nice to have some infinity specific instructions. This will become much more important as I release new keyboards in the near future.
I'm still trying to figure out the right balance between power/complexity and ease of use for first-timers.

Perhaps some "quick-build" scripts are in order along with the documentation.

[smasher816]

I am done moving over all the content from the readme. It should have all the content that was originally there. The wiki pages should be open to edit so feel free to clarify anything if you can - or even just add a "TODO: Could be explained better" or something like that for others to work on.

@haata I think quick build scripts would be a good idea. Would it be possible (or a good idea) to make a "Keyboards" type directory that contains the most common cmake defines. Ex: Infinity has mk20dx128vlf5 chip, MD1 scan, PartialMap macro, and pjrc usb. Then someone could run a script like ./build.sh infinity or whatever the name of a supported board is. It would then do a build with those definitions without any extra work, which would be nice for the first timers. For the more adventurous they could always dabble in the CMakeFiles themselves as they would have to now.

[haata]

I've made a first pass at the convenience compilation scripts here: 337eaa1

Still needs a bit more work to handle the cygwin case, but should be fine for Linux and Mac.

[haata]

Updated the README to be easier to read for a beginner.
a6edcce

[unphased]

I would suggest someone provide instructions on how to transition KLL's that were made with the web configurator into the build process. I can build a .bin using the default configuration and i know how to upload it with dfu-util, but I dont know which files to overwrite where with which other files (and which other files to edit to define the layers to refer back to the new KLL's) to be able to use this. Seems like cmake is needed to generate a bin from KLL's?

(For example we download in the zip file, e.g. 3 KLL's for 3 layers, plus 4 header files, which are just compiler products only really useful for debugging)

[braidn]

It is actually quite confusing to figure out where you need to be/should be when building a proper layout file. I also have not had a ton of time to help out on Doc betterment. However I wrote up a quick how-to here: http://cloudbacon.com/2015-04-05-infinity-keyboard-info

It will have you building layout files in no time.

On May 31, 2015, at 11:52, Steven Lu [email protected] wrote:

I would suggest tips on how to transition kll's that were made with the web configurator into a build folder. I can build stuff but I dont know which files to overwrite where with which other files to be able to use this. Seems like cmake is needed to generate a bin from kll's?

—
Reply to this email directly or view it on GitHub.

[unphased]

@braidn The breadcrumbs are much appreciated. Thanks.

What is the build.sh file you refer to? Your repo doesn't have it, neither does kiibohd/controller, neither do any of cmake/make product files contain such a script.

[braidn]

@unphased https://github.com/braidn/infinity. This is the build file I am using and the corresponding layouts.