annotate README.md @ 20:0555050bada0

Make it pretty
author VilyaemKenyaz
date Wed, 27 Sep 2023 08:51:57 -0400
parents 8fe0b5711413
children 44e906aeea91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
1b0ebe86b44c Automated Vimcurial commmit
VilyaemKenyaz
parents: 1
diff changeset
1 # Harelet
4
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
2 A simple CNC CAD program for milling machines
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
3 You may export RAW gcode or for Shopbot machines (OpenSBP)
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
4 To configure settings edit the definitions in
1
47e1b1039d7b Automated Vimcurial commmit
VilyaemKenyaz
parents: 0
diff changeset
5 the source code and recompile easily by executing the
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
6 compile script. By default the units are Imperial.
1
47e1b1039d7b Automated Vimcurial commmit
VilyaemKenyaz
parents: 0
diff changeset
7
4
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
8 ---
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
9
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
10 ## USAGE
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
11
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
12 All controls are lowercase.
11
1d4df12de9e3 Automated Vimcurial commmit
VilyaemKenyaz
parents: 4
diff changeset
13
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
14 Vim keys to move(HJKL).
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
15 k
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
16 h l
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
17 j
11
1d4df12de9e3 Automated Vimcurial commmit
VilyaemKenyaz
parents: 4
diff changeset
18 H Left
1d4df12de9e3 Automated Vimcurial commmit
VilyaemKenyaz
parents: 4
diff changeset
19 J Down
1d4df12de9e3 Automated Vimcurial commmit
VilyaemKenyaz
parents: 4
diff changeset
20 K Up
1d4df12de9e3 Automated Vimcurial commmit
VilyaemKenyaz
parents: 4
diff changeset
21 L Right
4
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
22
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
23
4
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
24 A to add a point at the current cursor's position
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
25
14
8b5ff478ec66 Automated Vimcurial commmit
VilyaemKenyaz
parents: 11
diff changeset
26 Q to exit
8b5ff478ec66 Automated Vimcurial commmit
VilyaemKenyaz
parents: 11
diff changeset
27
8b5ff478ec66 Automated Vimcurial commmit
VilyaemKenyaz
parents: 11
diff changeset
28 D to set cursor down or raised
8b5ff478ec66 Automated Vimcurial commmit
VilyaemKenyaz
parents: 11
diff changeset
29
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
30 C to compile instructions for a machine, you will be prompted for a filename
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
31
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
32 S to change step size, how far the cursor moves at a time
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
33
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
34 ## DVORAK
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
35
20
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
36 Harelet has built in Dvorak support, compile with -DVORAK.
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
37
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
38 Keys for QWERTY to DVORAK
4
0ed615367b10 Automated Vimcurial commmit
VilyaemKenyaz
parents: 2
diff changeset
39
19
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
40 , - Up
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
41 A - Left
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
42 O - Down
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
43 E - Right
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
44 X - Exit
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
45 p - Set DWN
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
46 Y - Compile
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
47 . - Set step size
8fe0b5711413 Added BasedTremGrx and Dvorak
VilyaemKenyaz
parents: 14
diff changeset
48 Space - Add point
20
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
49
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
50 ## CONTRIUTIONS
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
51
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
52 Notes on commits
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
53
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
54 Keep it granular
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
55
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
56 Keep it (C)imple
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
57
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
58 Keep it consistent with the vision
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
59
0555050bada0 Make it pretty
VilyaemKenyaz
parents: 19
diff changeset
60