cw 0.0.5 → 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +74 -10
  3. data/cw.gemspec +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c8c794c0c8a7b01afddd938dafa43edffed66b60
4
- data.tar.gz: cc85d6cab352aa6d7b386c50e5cc6f5e3c1f2b4f
3
+ metadata.gz: b66816e4dccbf0e2ced284eafa463bf78a2a6f04
4
+ data.tar.gz: 50d5466e0e3d5de60eb1b94659c4eced21d2a597
5
5
  SHA512:
6
- metadata.gz: b9223673c474a332758358a730ae3f1f0917bf7f92b8047d57b1180f50823823befadc72f62adc14a4d9ee5090a2b5124b7cab09af893927318fcec61b52283a
7
- data.tar.gz: e8a02db8b25a318678d87cfc12984da848d74797f0a04fda35948b830a6f7907c796fa4b30bf6e73d1e101bffae941b78b585ad8b08229dcf9f7295e939d7491
6
+ metadata.gz: 95ea30aec337412f9c09380203865ae76ba16c7e76b1676dc80dd82961188982cacc418250a015a2311c64e5109518850d12df0821881df3f1e4a09231c07bce
7
+ data.tar.gz: d277273af400e042a36b14996dfffbfc6c289ea67367693b5c7cd5d63c5e0134ebf18445acca79dc53361989fa2c300f66041e8259b213a1dceeaadb57152a79
data/README.md CHANGED
@@ -1,21 +1,85 @@
1
1
  # CW
2
2
 
3
+ CW is a DSL written in Ruby for generating audible morse, allowing for
4
+ real-time learning and testing of Morse Code.
5
+
6
+ CW can read books, rss feeds, common phrases, QSO codes etc, in
7
+ addition to generating random words that match some required pattern
8
+ (i.e. words_beginning_with 'v')
9
+
10
+ CW also allows for real-time marking by indicating correct and
11
+ incorrect characters and words typed in real-time.
12
+
3
13
  # Installation:
14
+
15
+ ```sh
16
+
17
+ gem install cw
18
+ ruby example.rb
19
+
4
20
  ```
5
- git clone https://github.com/mjago/CW.git cw
6
- cd cw
7
- gem install bundler
8
- bundle install
9
- bundle exec ruby example.rb
21
+
22
+ - Note: Currently only tested on OS X (uses afplay by default).
23
+
24
+ ```ruby
25
+
26
+ # example.rb (example script)
27
+
28
+ require 'cw'
29
+
30
+ CW.new do
31
+ comment 'read book feed (1 sentence)'
32
+ play_book(sentences: 1)
33
+ end
34
+
35
+ CW.new do
36
+ comment 'read book feed (1 minute)'
37
+ play_book(duration: 1)
38
+ end
39
+
40
+ CW.new do
41
+ comment 'read rss feed (1 article)'
42
+ read_rss(:reuters, 1)
43
+ end
44
+
45
+ CW.new do
46
+ name 'test straight alphabet'
47
+ alphabet
48
+ end
49
+
50
+ CW.new do
51
+ comment 'test straight numbers'
52
+ numbers
53
+ end
54
+
55
+ CW.new do
56
+ wpm 18
57
+ ewpm 12
58
+ load_abbreviations
59
+ shuffle
60
+ end
61
+
10
62
  ```
11
- # Usage:
12
63
 
13
64
  # Options:
14
65
 
15
- # Credits
16
-
17
- # Version History
66
+ Command / Alias
67
+ ---------------
68
+ - ewpm / effective_wpm
69
+ - no_run / pause
70
+ - comment / name
71
+ - repeat_word / double_words
72
+ - word_length / word_size
73
+ - word_shuffle / shuffle
74
+ - having_size_of / word_size
75
+ - number_of_words / word_count
76
+ - words_including / including
77
+ - words_ending_with / ending_with
78
+ - random_alphanumeric / random_letters_numbers
79
+ - words_beginning_with / beginning_with
80
+ - words_no_longer_than / no_longer_than
81
+ - words_no_shorter_than / no_shorter_than
18
82
 
19
83
  # License
20
84
 
21
- Open Source MIT License. See "LICENSE" file.
85
+ MIT License
data/cw.gemspec CHANGED
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'cw'
7
- spec.version = '0.0.5'
7
+ spec.version = '0.0.6'
8
8
  spec.date = '2016-05-21'
9
9
  spec.authors = ["Martyn Jago"]
10
10
  spec.email = ["martyn.jago@btinternet.com"]
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cw
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
4
+ version: 0.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Martyn Jago