Skip to content

Commit

Permalink
Add LICENSE and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alg0002 committed Jan 3, 2023
1 parent ee1417e commit cb64e12
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Let's Swamp

![Version](https://img.shields.io/badge/PCB%20Version-0.3-blue.svg)
![KiCAD design License:MIT](https://img.shields.io/badge/KiCAD%20design%20License-MIT-brightgreen.svg)
<!-- ![Gerber:CC-BY-NC](https://img.shields.io/badge/Gerber%20License-CC--BY--NC-blue.svg) -->

DIY keyboard "Let's Swamp"

![Let's Swamp v0.2proto](./images/let's-swamp-v02.jpg)

---

## ⌨️What is "Let's Swamp" ?

Let's Swamp is an ortholinear split keyboard.

![Let's Swamp v0.2proto](./images/kle-let's-swamp.png)

* 4x6x2=48keys
* Controller board : Waveshare RP2040-Zero
* Supported firmware :
- [Kermite](https://kermite.org/)
- [PRK Firmware](https://github.com/picoruby/prk_firmware)
- [QMK Firmware](https://docs.qmk.fm/#/)

---

## 📃License

* KiCad design files (in [`design`](./design/) directory) : MIT
<!--
* Gerber files (in `gerber` directory) : CC-BY-NC
-->
* Other files: MIT

I have modified [Salicylic-acid3/KiCAD_FootPrint](https://github.com/Salicylic-acid3/KiCAD_FootPrint) to use in this project.
21 changes: 21 additions & 0 deletions design/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 alg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Binary file added images/kle-let's-swamp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/let's-swamp-v02.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cb64e12

Please sign in to comment.