search

Cycling74 / min-devkit

Tools, documentation, and reference implementation of a Max Package built using the Min-API.
MIT License
163 stars 31 forks source link

suggested clarifications for build instructions #80

Closed nwolek closed 7 years ago

nwolek commented 7 years ago

Working on a fresh download of this repo after a Skype w @tap this morning. While working through the readme steps, I encountered the following hiccups:

  1. Followed the 'Building' steps found here in the readme.
  2. Step 1 would not work because the submodules were not present. Googling reminded me of this command to pull these updates. Should probably add a step to make this explicit.
  3. The submodule update also revealed that my SSH key was missing, probably through a system wipe. Was able to follow these steps, then upload it to my settings on GitHub.
  4. Once SSH was updated and I pulled the submodules, I was then able to proceed through steps 1 to 4 as described.
tap commented 7 years ago

Thanks @nwolek. I'm making some updates to try and help clear this up right now as I also have some related notes from @diablodale for improvements to the ReadMe specifically and documentation in general.

There is an element of this which will simply go away when Min is released. Namely all of the ssh key shenanigans caused by having a private git submodule. Because of that I'm not going to spend too much time documenting the SSH keygen stuff.

Clarifying the download info to get to a successful build I'm definitely addressing.