typerlude 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,31 @@
1
+ Typerlude is a composite project.
2
+
3
+ * The original Typerlude Rust and JavaScript source code is licensed under the MIT
4
+ License below.
5
+ * Project-authored practice data uses CC0 1.0 Universal: `assets/licenses/CC0-1.0.txt`
6
+ in source/Cargo/root npm and identical `licenses/CC0-1.0.txt` in native npm/archive.
7
+ * External dependencies, content, and assets remain under their own terms in
8
+ `THIRD_PARTY_LICENSES.html` and `THIRD_PARTY_NOTICES.md`; this file does not
9
+ relicense them under MIT or CC0.
10
+
11
+ MIT License
12
+
13
+ Copyright (c) 2026 Typerlude contributors
14
+
15
+ Permission is hereby granted, free of charge, to any person obtaining a copy
16
+ of this software and associated documentation files (the "Software"), to deal
17
+ in the Software without restriction, including without limitation the rights
18
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19
+ copies of the Software, and to permit persons to whom the Software is
20
+ furnished to do so, subject to the following conditions:
21
+
22
+ The above copyright notice and this permission notice shall be included in all
23
+ copies or substantial portions of the Software.
24
+
25
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31
+ SOFTWARE.
package/README.ko.md ADDED
@@ -0,0 +1,70 @@
1
+ # Typerlude
2
+
3
+ A typing interlude for your terminal.
4
+
5
+ [English](README.md) | [한국어](README.ko.md)
6
+
7
+ Typerlude는 계정, 텔레메트리, 클라우드 저장소 없이 키, 단어, 문장, 긴 글, 시간제 시험을
8
+ 연습하는 오프라인 우선 한국어·영어 터미널 타자 연습기입니다.
9
+
10
+ ## 설치
11
+
12
+ 레지스트리 배포 여부는 아직 검증되지 않았습니다. 패키지가 공개된 뒤에는 다음을 사용하세요.
13
+
14
+ ```bash
15
+ npm install -g typerlude
16
+ typerlude
17
+ ```
18
+
19
+ ```bash
20
+ cargo install typerlude
21
+ typerlude
22
+ ```
23
+
24
+ 그전에는 현재 소스에서 실행하세요.
25
+
26
+ ```bash
27
+ git clone https://github.com/baba9811/typerlude.git
28
+ cd typerlude
29
+ cargo run --release --
30
+ ```
31
+
32
+ UTF-8 대화형 터미널을 사용하세요. 권장 최소 크기는 80×24입니다.
33
+
34
+ ## 사용
35
+
36
+ 홈 화면에서 모드를 고르고 옵션을 조정한 뒤 `Enter`를 누르세요. `Tab`, 화살표 키, `j`, `k`로
37
+ 포커스를 옮기고, `Esc`로 뒤로 가거나 지원 모드를 일시 정지하며, `q`로 종료합니다. 점수 연습
38
+ 중 붙여넣기는 무시됩니다.
39
+
40
+ ```bash
41
+ typerlude --help
42
+ typerlude notes.txt
43
+ typerlude stats
44
+ typerlude history
45
+ typerlude paths
46
+ typerlude themes
47
+ typerlude licenses
48
+ ```
49
+
50
+ 사용자 텍스트는 메모리에만 남고 세션 기록에 복사되지 않습니다. 로컬 세션 기록에는 집계된
51
+ 연습 지표와 의도한 키별 횟수만 저장됩니다.
52
+
53
+ ## 더 알아보기
54
+
55
+ - [Content-pack guide](docs/content-packs.md) / [콘텐츠 팩 안내](docs/content-packs.ko.md)
56
+ - [배포 안내](docs/releasing.md)
57
+ - [보안 정책](SECURITY.md)
58
+ - [라이선스와 제3자 고지](LICENSE) / [자료 권리](THIRD_PARTY_NOTICES.md)
59
+
60
+ ## 개발
61
+
62
+ ```bash
63
+ git clone https://github.com/baba9811/typerlude.git
64
+ cd typerlude
65
+ cargo run --
66
+ make test
67
+ ```
68
+
69
+ Typerlude는 Rust 1.88.0을 고정합니다. 전체 검증에는 Node.js와 CI에 문서화한 정책 도구도
70
+ 사용합니다.
package/README.md ADDED
@@ -0,0 +1,70 @@
1
+ # Typerlude
2
+
3
+ A typing interlude for your terminal.
4
+
5
+ [English](README.md) | [한국어](README.ko.md)
6
+
7
+ Typerlude is an offline-first Korean and English typing tutor for the terminal. Practice keys,
8
+ words, sentences, long text, and timed tests without an account, telemetry, or cloud storage.
9
+
10
+ ## Install
11
+
12
+ Registry availability is not yet verified. Once the packages are published:
13
+
14
+ ```bash
15
+ npm install -g typerlude
16
+ typerlude
17
+ ```
18
+
19
+ ```bash
20
+ cargo install typerlude
21
+ typerlude
22
+ ```
23
+
24
+ Until then, run the current source:
25
+
26
+ ```bash
27
+ git clone https://github.com/baba9811/typerlude.git
28
+ cd typerlude
29
+ cargo run --release --
30
+ ```
31
+
32
+ Use a UTF-8 interactive terminal; 80×24 is the recommended minimum size.
33
+
34
+ ## Use
35
+
36
+ Choose a mode on the home screen, adjust its options, then press `Enter`. `Tab`, arrow keys,
37
+ `j`, and `k` move focus; `Esc` goes back or pauses supported practice; `q` quits. Paste is
38
+ ignored during scored practice.
39
+
40
+ ```bash
41
+ typerlude --help
42
+ typerlude notes.txt
43
+ typerlude stats
44
+ typerlude history
45
+ typerlude paths
46
+ typerlude themes
47
+ typerlude licenses
48
+ ```
49
+
50
+ User text stays in memory and is not copied into session history. Local session records contain
51
+ only aggregate practice metrics and intended-key counts.
52
+
53
+ ## More
54
+
55
+ - [Content-pack guide](docs/content-packs.md) / [콘텐츠 팩 안내](docs/content-packs.ko.md)
56
+ - [Release guide](docs/releasing.md)
57
+ - [Security policy](SECURITY.md)
58
+ - [License and third-party notices](LICENSE) / [data rights](THIRD_PARTY_NOTICES.md)
59
+
60
+ ## Develop
61
+
62
+ ```bash
63
+ git clone https://github.com/baba9811/typerlude.git
64
+ cd typerlude
65
+ cargo run --
66
+ make test
67
+ ```
68
+
69
+ Typerlude pins Rust 1.88.0. The complete gate also uses Node.js and the policy tools documented by
70
+ CI.