search

tmk / tmk_keyboard

Keyboard firmwares for Atmel AVR and Cortex-M
3.99k stars 1.71k forks source link

Removal of projects or separation of core library and project #173

Open tmk opened 9 years ago

tmk commented 9 years ago

I have plan to remove some of projects which I can't mainatain from repository, or move projects to another(each own) repository.

1) Most of converter projects will continue to be updated by hasu/tmk(me) because I still own keyboards needed to test firmware. Meanwhile most of keyboard projects can't be tested. hasu/tmk owns keyboard pojejcts; gh60, hbkb, hhkb, infinity, onekey and onekey_mbed. But they may be separated from core library.

2) If contributor of the project has a repository it should be center of the project. README of tmk_keyboard just has a link to the repository and tmk_keyboard has no code for the project. Place your repository link on this wiki page: https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects

Update: 2016/01 Moved some projects to orphan directory now. 649151c

rhaberkorn commented 3 years ago

I'm about to release my own controller based on tmk - it's for the VEB Robotron K7637 keyboard in case you wonder. I'm unsure how to proceed. The best way would certainly be to add tmk_core as a submodule to a repository containing only my new controller firmware. But the tmk_core repository seems to be hopelessly outdated. So I will fork tmk_keyboard and do my work on a dedicated branch that I can rebase if necessary. This seems to be what most people do.

@tmk Why don't you use a tmk_core submodule in the development of tmk_keyboard? I would suggest to

  1. throw away all the history of the tmk_core repo:
    • rename the existing master branch, so the Git commits will stay around and you don't break anybody's repo
    • create a new completely empty master branch
    • pull from tmk_keyboard, effectively making tmk_core a clone of tmk_keyboard
    • remove any controller and converter and move the contents of the tmk_core subdirectory to the root of the tmk_core repo - this will make sure that history of tmk_core from tmk_keyboard is preserved
  2. add the newly synced tmk_core repo as a submodule to tmk_keyboard
tmk commented 3 years ago

I still have a plan and will do that in the end. But it won't happen some time soon. I don't have enough time to do properly and another reason is my laziness.

tmk_core was updated using git-subtree merge and this makes process a bit complex. I'll base on submodule instead next time.

tmk commented 3 years ago

The tmk_core repo was updated with change sets from this repo now. https://github.com/tmk/tmk_core/commit/8bfaa6ce5380323c77427cf2a01ae2092db5ff49

This repo will be changed later once my topic branches in progress are settled.

rhaberkorn commented 3 years ago

I have published my project using a tmk_core submodule as was suggested. Could you add a link to my project, please?

VEB Robotron K7637 Replacement Controller and Firmware

tmk commented 3 years ago

Interesting project! Done.