aboutsummaryrefslogtreecommitdiff
path: root/keyboards/cool836a/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/cool836a/readme.md')
-rw-r--r--keyboards/cool836a/readme.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/keyboards/cool836a/readme.md b/keyboards/cool836a/readme.md
new file mode 100644
index 000000000..dd3ace3cb
--- /dev/null
+++ b/keyboards/cool836a/readme.md
@@ -0,0 +1,51 @@
1# cool836A
2
3- このプロジェクトの詳細については設計者たる[m.ki様](https://twitter.com/0002ozlet)による[GitHubリポジトリ](https://github.com/telzo2000/cool836A)の記述をご覧ください。
4
5### バージョン(A, B+, C+)について
6- m.ki様によるとどのバージョンも回路は同じで、ファームウェアを分ける必要はないとのことです。
7- しかしながらこのファームウェアは、cool836A ver.B+ (通称レッドバージョン)のみでテストされています(2021年1月7日現在)。そのため念のため、当面の間はサブフォルダの名前をcool836A/verB_REDとさせていただきます。
8- ほかのバージョンに書き込んだときに不具合等がありましたら、方はお気軽に私[オオハシ](https://twitter.com/oha_oha_Ohashi)までご連絡ください。
9
10
11## 申し訳程度のチュートリアル
12詳細に書き込む労力は払えませんでしたが、最低限のコードのみ記します。
13
14git clone のあと、
15
16``` make cool836A/verB_RED:default ```
17
18でコンパイル可能であることを確認し、
19
20``` make cool836A/verB_RED:default:avrdude ```
21
22によってデフォルトキーマップをPro Microに焼けるかもしれません。
23`default`の代わりに`Ohasheen`を利用することもできます。
24
25初心者の方はもっと素晴らしいウェブサイトでGitやqmk firmwareの使い方を覚えていただくのがよいかと思います。
26
27
28
29-----------------
30## English
31- [Here](https://github.com/telzo2000/cool836A) are a full description of this project and build guide by the great Designer: [m.ki](imgur.com image replace me!)
32
33- Each virsions(A, B+, C+) of cool836A has the same circuit and that means you can install this firmware on any of them.
34- However, this repository is currently(Jan 7, 2021) tested on ver.B+ (RED version) only. Feel free to contact [ME](https://github.com/ketcha-k) for any problems.
35
36- firmware maintainer: [Ohashi](https://github.com/ketcha-k)
37
38## Such a humble tutorial
39The author would like to provide a minimum guide.
40
41After cloning the repository, you may want to
42
43``` make cool836A/verB_RED ```
44
45to make sure it's compilable, and
46
47``` make cool836A/verB_RED:default ```
48
49which leads you to the goal.
50
51It is recommended that beginners learn how to get started with qmk firmware/configurator at other fantastic websites rather than here......