While @jesse is busy in China, I offered my help in getting as much of the plugins in an “1.0.0” state as possible. This means that they should be reasonably stable, and documented too. I’m starting with the plugins used by the factory firmware, and most of them have some documentation by now. Howev…

[image] bagels: So, I fumbled through the documentation and had a fun time discovering what I needed to do to get a (mostly-same) build as the official firmware. I’d be happy to try to spend some time writing it up or expanding on the existing documentation and listing where I pulled things fro…

Alright, once I get some time I’ll take a stab at building out some documentation. I know I signed up for a painful process with the PVT program – fortunately this is the kind of stuff I love! And you’re right, I pulled everything from the head, not from the PVT tag. That’s likely my own fault an…

In general, I think we want to encourage folks who want the latest working code to pull from master. It’s useful to be able to rebuild the shipping firmware, but I don’t think it’s likely to be the right starting point for most folks. (I do expect to keep the keymaps for the default firmware more …

[image] algernon: I’d be very interested in having that in the plugin, if you don’t mind sending a pull request =) No worries, I am definitely planning on sharing it back once I get it into a cleaned-up, documented state following the code standards guide. It was very much a hack-and-slash a…

As a note on the coding standard: We cribbed from Google and have been trying to adapt the standard to something that would make sense for us. If there are bits that seem…wrong, please shout.

Absolutely personal preference, but I really dislike 2-space indents. 4-space is where it’s at for me! It’s just a lot easier to see indentation levels. For now, I’ll astyle the source so it’s readable for me and then astyle it back before I commit. :slight_smile: As another aside, what is every…

[image] bagels: Absolutely personal preference, but I really dislike 2-space indents. 4-space is where it’s at for me! It’s just a lot easier to see indentation levels. For now, I’ll astyle the source so it’s readable for me and then astyle it back before I commit. :slight_smile: Using ast…

I might try to get CLion setup. I’d be happy to share configs with that, if I get it fully working. JetBrains actually has free licenses for OpenSource project contributors – https://www.jetbrains.com/buy/opensource/ The only thing I don’t know about is if this would fall under “commercially supp…

Thanks so much! We also need to get pre-commit hooks in place to run our style and smoke tests.

[image] bagels: As another aside, what is everybody using for development? I have been using a combo of vim and sublime text, but I’d really like to get CLion setup and working with all of the libraries (as I use IntelliJ IDEA for most of my professional work). Emacs (Spacemacs, in particula…

Preparing plugins for 1.0.0: Looking for documentation reviewers

Programming

Topic		Replies	Views
Creating a keyboard remapping tutorial Programming	57	4893	October 14, 2017
Managing core and contributed Kaleidoscope plugins Programming	32	4280	December 8, 2017
Getting started compiling firmware - documentation duplicate? Programming question	28	1860	December 11, 2017
Feedback requested: simplified software installation Programming	38	3552	November 10, 2017
Introducing Kaleidoscope-MacrosOnTheFly Plugins	20	2784	March 31, 2021

Preparing plugins for 1.0.0: Looking for documentation reviewers

Related topics