docs: Removed software directory and flattened the hardware directory - #38
Open
Tygo-van-den-Hurk wants to merge 4 commits into
Open
docs: Removed software directory and flattened the hardware directory#38Tygo-van-den-Hurk wants to merge 4 commits into
Tygo-van-den-Hurk wants to merge 4 commits into
Conversation
As discussed in #33, the software directory does not belong in this repostitory as this is the hardware repository. Further more I expanded the documentation to explain why we use points for the microcontroller for example, and how we use it. Closes #19: "Hardware documentation out of date.". Closes #20: "Explain why we created points in hardware README". Closes #33: "docs: Remove software directory".
github-actions
Bot
added
bug
This guide contains an overview of how to build the keyboard from scratch, even if it is a little more sparse then I'd have liked. The pictures for example are placeholders until I solder a new keyboard and have a chance to actually take pictures. Closes #31: "feat: add guide".
Tygo-van-den-Hurk
force-pushed
the
fix/remove-software-dir
branch
from
July 12, 2025 00:13
1644c2b to
c3a7495
Compare
This guide contains an overview of how to build the keyboard from scratch, even if it is a little more sparse then I'd have liked. The pictures for example are placeholders until I solder a new keyboard and have a chance to actually take pictures. Closes #31: "feat: add guide".
I am not done with these changes but am about to wipe my computer.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As discussed in #33, the software directory does not belong in this repository as this is the hardware repository. Further more I expanded the documentation to explain why we use points for the micro controller for example, and how we use it.
Also added a guide. This guide contains an overview of how to build the keyboard from scratch,
even if it is a little more sparse then I'd have liked. The pictures for
example are placeholders until I solder a new keyboard and have a chance
to actually take pictures.
Closes #19: "Hardware documentation out of date.".
Closes #20: "Explain why we created points in hardware README".
Closes #31: "feat: add guide".
Closes #33: "docs: Remove software directory".