Skip to content

Commit dd036c6

Browse files
u-235u-235
committed
EdytorNC->GCodeWorkShop: update docs
1 parent 0e85601 commit dd036c6

File tree

5 files changed

+112
-80
lines changed

5 files changed

+112
-80
lines changed

‎README.md‎

Lines changed: 70 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,83 @@
1-
## EdytorNC
2-
3-
This is a [fork](http://sourceforge.net/projects/edytornc/) of EdytorNC, a text editor for CNC programmers.
4-
5-
### Some features
6-
7-
* Bolt holes calculation
8-
* Solutions of triangles calculation
9-
* Speed, feed calculation
10-
* Send/receive through serial port with automatic file saving and Serial port file server - possibility to download new CNC program directly from machine.
11-
* Conversion inch/mm, mm/inch. You can write inches in format 1.3/4 1/4 ...
12-
* Find in files
13-
* Simple project management - you can keep links to (almost) all files related to your part program in one place.
14-
* First comment in program is displayed in title bar. In first comment you can write part name.
15-
* Comment with date will be replaced with current date on file save. Comment format: (dd-/.mm-/.yyyy) or ;dd-/.mm-/.yyyy - now system localization settings are used.
16-
* Block renumbering - whole program or selection
17-
* Code colourizing. Now with help function - click on "Help"->"Create cnc tooltips" and put mouse pointer above G, M or other codes - should appear tooltip with short information about pointed code.
18-
19-
Default tooltips are in file "cnc_tooltips_lang_code.txt" (lang_code = pl_PL - for Polish) in folder with application settings (~.config on Linux. C:\Documents and Settings\USERNAME\Application Data\EdytorNC on Windows).
20-
21-
You may copy it to folder with cnc programs and customize for your machine. File must be renamed to "cnc_tips.txt". Now this is done by functions in help menu.
22-
23-
Currently tooltip file contains some information about codes for OKUMA, SINUMERIK 850 and FANUC.
24-
25-
Code colourizing detects control type by 'in file' file name eg. : $EXAMPLE.MIN% $SUBS.SSB% - OKUMA; :0110 O1234 - FANUC
26-
* Ctrl+; Comments/uncomments selected text with semicolon ;
27-
* Ctrl+9 Comments/uncomments selected text with parentheses ()
28-
* Ctrl+2 Adds Block Skip (/) and/or increments it
29-
* Ctrl+3 Adds Block Skip (/) and/or decrements it
30-
* Ctrl+1 Removes Block Skip (/)
31-
* Find/Replace can be used to addition, subtraction, multiplication, division on numbers or highlighting text.
32-
33-
in Find: Y$$ in Replace $$*2 will multiply by 2 all numbers found with Y
34-
35-
in Find: Y$100 $10 in Replace $$*2 will multiply by 2 only numbers between 10 and 100 found with Y
36-
37-
Find can be used also to highlight specific program blocks
38-
* Sessions - to save/restore open file list
39-
* Ctrl+0 or Ctrl+Double Click In line calculator, you can do some math operations directly in editor. You can select address (eg X123.45) before pressing Ctrl+0 (Ctrl+Double Click will do the same), value will be entered in the calc.
40-
41-
After presing Enter (and if no error) result will be pasted in cursor position. Supported operators: + - * / SIN(x) COS(x) TAN(x) SQRT(x) SQR(x) ABS(x) TRUNC(x) PI
42-
43-
* Clipboard to store five last texts copied to system clipboard. Later they can be stored permanently (by editing item title).
44-
45-
46-
### Experimental features
47-
* macro program - parametric programming. See EXAMPLES dir.
48-
* split file - if file contains more than one program this function tries to split it into separate files. No auto save yet.
49-
50-
51-
### Command line options
52-
53-
- open file -> `edytornc file.nc`
54-
- diff two files -> `edytornc -diff file1.nc file2.nc`
55-
56-
57-
### Compile EdytorNC
58-
59-
#### Ubuntu
1+
GCodeWorkShop
2+
============
3+
4+
This is a fork of [EdytorNC](https://github.com/artur3/EdytorNC), a text editor
5+
for CNC programmers.
6+
7+
8+
Some features
9+
------------
10+
11+
* Code colourizing.
12+
* Sessions - to save/restore open file list
13+
* Send/receive through serial port with automatic file saving and Serial port
14+
file server - possibility to download new CNC program directly from machine.
15+
* Find in files
16+
* Find/Replace can be used to addition, subtraction, multiplication, division
17+
on numbers or highlighting text.
18+
in Find: `Y$$` in Replace `$$*2` will multiply by 2 all numbers found with `Y`
19+
in Find: `Y$100$10` in Replace `$$*2` will multiply by 2 only numbers between
20+
`10` and `100` found with `Y`
21+
Find can be used also to highlight specific program blocks
22+
* Simple project management - you can keep links to (almost) all files related
23+
to your part program in one place.
24+
* First comment in program is displayed in title bar. In first comment you can
25+
write part name.
26+
* Comment with date will be replaced with current date on file save. Comment
27+
format: (dd-/.mm-/.yyyy) or ;dd-/.mm-/.yyyy - now system localization settings are used.
28+
* Block renumbering - whole program or selection
29+
* Conversion inch/mm, mm/inch. You can write inches in format `1.3/4` `1/4` ...
30+
* Speed, feed calculation
31+
* Bolt holes calculation
32+
* Solutions of triangles calculation
33+
34+
35+
Some shotcuts
36+
------------
37+
38+
* `Ctrl+;` Comments/uncomments selected text with semicolon ;
39+
* `Ctrl+9` Comments/uncomments selected text with parentheses ()
40+
* `Ctrl+2` Adds Block Skip (/) and/or increments it
41+
* `Ctrl+3` Adds Block Skip (/) and/or decrements it
42+
* `Ctrl+1` Removes Block Skip (/)
43+
* `Ctrl+0` or `Ctrl+Double Click` In line calculator, you can do some math
44+
operations directly in editor. You can select address (eg `X123.45`) before
45+
pressing `Ctrl+0` (`Ctrl+Double Click` will do the same), value will be
46+
entered in the calc.
47+
After presing `Enter` (and if no error) result will be pasted in cursor
48+
position. Supported operators: `+` `-` `*` `/` `SIN(x)` `COS(x)` `TAN(x)`
49+
`SQRT(x)` `SQR(x)` `ABS(x)` `TRUNC(x)` `PI`
50+
51+
52+
Command line options
53+
------------------
54+
55+
- open file -> `gcodeworkshop file.nc`
56+
- diff two files -> `gcodeworkshop -diff file1.nc file2.nc`
57+
58+
59+
Compile GCodeWorkShop
60+
-------------------
61+
62+
63+
### Ubuntu
6064

6165
run terminal
6266
```
6367
sudo apt install qt5-default qtbase5-dev-tools qt5-qmake
6468
cd ~
65-
git clone https://github.com/u-235/edytornc
66-
cd edytornc
69+
git clone https://github.com/GCodeProjects/GCodeWorkShop
70+
cd GCodeWorkShop
6771
qmake -r [CONFIG+=debug] [PREFIX=/usr/ | PREFIX=~/.local/bin/]
6872
make
73+
make lrelease
6974
```
7075

71-
#### Windows
76+
77+
### Windows
7278

7379
- [Install Qt5](http://www.qt.io/download-open-source)
74-
- download latest version of EdytorNC [source files](https://github.com/u-235/edytornc/archive/master.zip)
80+
- download latest version of GCodeWorkShop [source files](https://github.com/GCodeProjects/GCodeWorkShop/archive/master.zip)
7581
- unzip downloaded file
76-
- open edytornc.pro in Qt Creator
82+
- open gcodeworkshop.pro in Qt Creator
7783
- press Ctrl+R

‎gcodefileserver/gcodefileserver.cpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
#include <serialportconfigdialog.h> // for SerialPortConfigDialog
4848
#include <serialtransmissiondialog.h> // for SerialTransmissionDialog
4949
#include <utils/medium.h> // for Medium
50+
#include <version.h>
5051

5152
#include "gcodefileserver.h"
5253
#include "filechecker.h" // for FileChecker
@@ -580,18 +581,17 @@ void GCodeFileServer::quitApp()
580581

581582
void GCodeFileServer::about()
582583
{
583-
QMessageBox::about(this, tr("About GCodeWorkShop - Serial port file server"),
584-
tr("The <b>GCodeWorkShop</b> is text editor for CNC programmers."
585-
"<P>Version: same as GCodeWorkShop"
584+
QMessageBox::about(this, tr("About GCodeFileServer"),
585+
tr("The <b>GCodeFileServer</b> is part of GCodeWorkShop."
586+
"<P>Version: %1"
586587
"<P>Copyright (C) 1998 - 2015 by <a href=\"mailto:artkoz78@gmail.com\">Artur Kozioł</a>"
587-
"<P>"
588-
"<P>GCodeWorkShop contains pieces of code from other Open Source projects."
589-
"<P>"
590-
"<P><i>GCodeWorkShop - Serial port file server is free software; you can redistribute it and/or modify"
588+
"<br>Copyright (C) 2020 - 2024 by <a href='mailto:nicegorov@yandex.ru'>Nick Egorrov</a>"
589+
"<P>GCodeFileServer contains pieces of code from other Open Source projects."
590+
"<P><i>GCodeFileServer is free software; you can redistribute it and/or modify"
591591
"it under the terms of the GNU General Public License as published by"
592592
"the Free Software Foundation; either version 2 of the License, or"
593593
"(at your option) any later version.</i>"
594594
"<P><i>The program is provided AS IS with NO WARRANTY OF ANY KIND,"
595595
"INCLUDING THE WARRANTY OF DESIGN,"
596-
"MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</i>"));
596+
"MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</i>").arg(GCODEWORKSHOP_VERSION));
597597
}

‎gcodeshared/gcodeshared.pro‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ SOURCES += \
1818
serialportconfigdialog.cpp
1919

2020
HEADERS += \
21+
include/version.h \
2122
serialportsettings.h \
2223
serialporttestdialog.h \
2324
serialtransmissiondialog.h \

‎gcodeshared/include/version.h‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
* Copyright (C) 2024 Nick Egorrov, nicegorov@yandex.ru
3+
*
4+
* This file is part of GCodeWorkShop.
5+
*
6+
* GCodeWorkShop is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU General Public License as published by
8+
* the Free Software Foundation, either version 2 of the License, or
9+
* (at your option) any later version.
10+
*
11+
* This program is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
* GNU General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU General Public License
17+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
18+
*/
19+
20+
#ifndef VERSION_H
21+
#define VERSION_H
22+
23+
#ifndef GCODEWORKSHOP_VERSION
24+
#define GCODEWORKSHOP_VERSION "2024.05"
25+
#endif
26+
27+
#endif // VERSION_H

‎gcodeworkshop/src/gcodeworkshop.cpp‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@
119119
#include <serialporttestdialog.h> // SerialPortTestDialog
120120
#include <serialtransmissiondialog.h> // SerialTransmissionDialog
121121
#include <utils/medium.h> // Medium
122+
#include <version.h>
122123

123124
#include "capslockeventfilter.h" // for CapsLockEventFilter
124125
#include "findinf.h" // for FindInFiles
@@ -1229,8 +1230,10 @@ void GCodeWorkShop::about()
12291230
{
12301231
QMessageBox::about(this, tr("About GCodeWorkShop"),
12311232
tr("The <b>GCodeWorkShop</b> is text editor for CNC programmers."
1232-
"<P>Version: " "2018-07-26 BETA"
1233+
"<br>This is a fork of <a href='https://github.com/artur3/EdytorNC'>EdytorNC</a>."
1234+
"<P>Version: %1"
12331235
"<P>Copyright (C) 1998 - 2018 by <a href=\"mailto:artkoz78@gmail.com\">Artur Kozioł</a>"
1236+
"<br>Copyright (C) 2020 - 2024 by <a href='mailto:nicegorov@yandex.ru'>Nick Egorrov</a>"
12341237
"<P>Spanish translation, fixes and other help thanks to Otto Huamani"
12351238
"<br />Catalan translation and deb package thanks to Jordi Sayol i Salomó"
12361239
"<br />German translation and other fixes thanks to Michael Numberger"
@@ -1239,20 +1242,15 @@ void GCodeWorkShop::about()
12391242
"<br />Dutch translation thanks to Henk van Andel"
12401243
"<br />OS X patch and other updates thanks to Janne Mäntyharju"
12411244
"<P>New EdytorNC icon thanks to Jakub Gajewski"
1242-
"<P><a href=\"http://sourceforge.net/projects/edytornc/\">http://sourceforge.net/projects/edytornc</a>"
1243-
"<P><a href=\"https://plus.google.com/communities/117267107585407507443/\">EdytorNC Google Plus Community</a>"
1244-
"<P>"
1245-
// "<P>Cross platform installer made by <a href=\"http://installbuilder.bitrock.com/\">BitRock InstallBuilder for Qt</a>"
1246-
// "<P>"
1245+
"<P><a href='https://github.com/GCodeProjects/GCodeWorkShop'>GCodeWorkShop on GitHub</a>"
12471246
"<P>GCodeWorkShop contains pieces of code from other Open Source projects."
1248-
"<P>"
12491247
"<P><i>GCodeWorkShop is free software; you can redistribute it and/or modify"
12501248
"it under the terms of the GNU General Public License as published by"
12511249
"the Free Software Foundation; either version 2 of the License, or"
12521250
"(at your option) any later version.</i>"
12531251
"<P><i>The program is provided AS IS with NO WARRANTY OF ANY KIND,"
12541252
"INCLUDING THE WARRANTY OF DESIGN,"
1255-
"MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</i>"));
1253+
"MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</i>").arg(GCODEWORKSHOP_VERSION));
12561254
}
12571255

12581256
void GCodeWorkShop::updateMenus()

0 commit comments

Comments
 (0)