Yona-Appletree / LEDscape

Beagle Bone Black cape and firmware for driving a large number of WS281x LED strips.
126 stars 58 forks source link

Move config file to /etc, limit support to Wheezy, various other superficial changes to help 1st time users #45

Closed bigjosh closed 7 years ago

bigjosh commented 7 years ago

Some updates to the readme to reflect new Debian versions and Beaglebone Black

bigjosh commented 7 years ago

These updates are highly opinionated with the goal of getting newcomers to "first blink" as quickly and simply as possible by...

  1. simplifying the README to only support a single distribution
  2. Adding some images and sample connection setups
  3. Defaulting to the simpler RGB-123-V3 pin mapping
  4. Making HDMI stuff an optional later step
  5. Using an install script rather than commands

I don't expect you to merge this PR, only to open the conversation and see if you might be interested in integrating something like this approach into your fork.

Yona-Appletree commented 7 years ago

This looks great. It conflicts with some other changes, but if you update it to fix those, I'll probably take it. I'd really like to get the TTFB (time to first blink) as short as possible. I'd absolutely love to get a good installer script written and then package it as a deb, but I just don't have the time at the moment. Anything that moves us in that direction is a welcome change.

bigjosh commented 7 years ago

This pull request is ready for a fast-forward merge.

It has the following major changes that you may or may not agree with:

  1. Moves the config file to /etc.

    This allows in-place updates without loosing config state, and also gets rid of all the forks from people who are just editing their config file.

    There is a note in the "upgrading" section letting existing users know that they should move their existing file.

  2. Explicitly only supports Wheezy.

    Jessie just won't work until someone has time to port to the new remoteproc stuff, or they add support for ius_pruss. By making the limited support explicit, the instructions can be simplified and we can save people from wasting time on unsupported platforms. (Note that I've found other unrelated issues with Jessie, so I'm not in a rush to jump on it anyway.)

I think the rest of the changes are superficial and should not impact existing users- mostly just trying to make things easier and clearer for first time installers.

LMK what you think. Thanks!