You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Initially, you can use the menu designer UI that is packaged with every release,
6
6
7
7
TheCodersCorner.com invest a lot of time and resources into making this open source product which is used by literally thousands of users. Releasing a UI, renting server space cost more than you'd think. Please consider at least making this project cost neutral to me by using either option to sponsor the project. We have [some commercial offerings](https://www.thecoderscorner.com/support-services/training-support/)_but these are presently very limited as I work full time_.
8
8
9
-
Sponsor me on [GitHub](https://github.com/davetcc/tcMenu) (this repository).
9
+
Sponsor me on [GitHub](https://github.com/TcMenu/tcMenu) (this repository).
10
10
11
11
<ahref="https://www.buymeacoffee.com/davetcc"target="_blank"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png"alt="Buy Me A Coffee"style="height: 60px!important;width: 217px!important;" ></a>
12
12
@@ -33,7 +33,7 @@ Community questions can be asked in the discussions section of this repo, or usi
33
33
34
34
Releases are directly available from the releases page, there is a signed Windows version, notarized macOS version, and a package for Linux:
35
35
36
-
[Get the latest TcMenu Designer release](https://github.com/davetcc/tcMenu/releases)
36
+
[Get the latest TcMenu Designer release](https://github.com/TcMenu/tcMenu/releases)
37
37
38
38
Although most will use the above packages, it's also possible to build from source, full instructions are in the tcMenuGenerator folder. We ask that you only build from source for your own use.
39
39
@@ -63,23 +63,23 @@ TcMenu supports different boards and build tools. It is possible to use it direc
* TFT-eSPI by Bodmer - https://github.com/Bodmer/TFT_eSPI
77
77
* Adafruit_GFX by AdaFruit- https://github.com/adafruit/Adafruit-GFX-Library
78
78
* U8G2 by olikraus - https://github.com/olikraus/u8g2
79
79
80
80
### Main Java source code locations
81
81
82
-
The designer UI code base and plugins for 2.0 onwards are located in this repository, the 1.7 plugins were here https://github.com/davetcc/tcMenuXmlPlugins. The designer, library and shipped plugins are all Apache licensed.
82
+
The designer UI code base and plugins for 2.0 onwards are located [in this repository](https://github.com/TcMenu/tcMenu/tree/main/xmlPlugins). The designer, library and shipped plugins are all Apache licensed.
83
83
84
84
## Input and display technologies
85
85
@@ -117,7 +117,7 @@ We have a fork LiquidCrystal for 20x4 or 16x2 displays - can be either directly
117
117
118
118
Most libraries that are compatible with Adafruit_GFX will work with tcMenu, we've tested with the following TFT's ILI9341, ST7735 and also Nokia 5110 display. We even have a quick start option that helps you get started with this option.
119
119
120
-
For mbed RTOS 5/6 we have a custom Adafruit_GFX OLED driver https://github.com/davetcc/Adafruit-GFX-mbed-fork that supports SSD1306, SH1106.
120
+
For mbed RTOS 5/6 we have a custom Adafruit_GFX OLED driver https://github.com/TcMenu/Adafruit-GFX-mbed-fork that supports SSD1306, SH1106.
121
121
122
122
### U8G2 integration for mono display
123
123
@@ -163,21 +163,21 @@ There is a java API for accessing the menu remotely, source includes JavaDoc to
163
163
164
164
The C# API is relatively complete and can do most of what the Java API can do, it is well tested and stable.
165
165
166
-
Repo: https://github.com/davetcc/tcMenuController
166
+
Repo: https://github.com/TcMenu/tcmenu-dotnet-sdk
167
167
168
168
### Python API
169
169
170
-
There is now a Python API thanks to @vzahradnik - https://github.com/davetcc/tcmenu-python
170
+
There is now a Python API thanks to @vzahradnik - https://github.com/TcMenu/tcmenu-python-sdk
171
171
172
172
### JavaScript and TypeScript
173
173
174
-
There is also an early version of a TypeScript API that can be used from any JavaScript environment. https://github.com/davetcc/embedcontrolJS. In the future, we may better package this API to a package manager.
174
+
There is also an early version of a TypeScript API that can be used from any JavaScript environment. https://github.com/TcMenu/embedcontrolJS. In the future, we may better package this API to a package manager.
175
175
176
176
There is also a Webserver/HTML based app that you can deploy, but it only really works from a Raspberry PI with the embedded Java support. It is somewhat limited in what it offers. After careful evaluation we decided NOT to support ESP32 and STM32 for this app at the moment as it is too large for them.
177
177
178
178
## Working with menus using the CLI
179
179
180
-
The most recent builds of TcMenu Designer include a CLI that has support for creating projects, adding and removing items, verifying and generating menus. [Building and Generating menus from the CLI](https://www.thecoderscorner.com/products/arduino-libraries/tc-menu/tcmenu-cli-workflow/)
180
+
The most recent builds of TcMenu Designer include a CLI that has support for creating projects, adding and removing items, verifying and generating menus. [Building and Generating menus from the CLI](https://tcmenu.github.io/documentation/products/arduino-libraries/tc-menu/tcmenu-cli-workflow/)
Copy file name to clipboardExpand all lines: tcMenuGenerator/README.md
+3-5
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,9 @@ This the repository for the designer UI, it is a cross-platform UI built using J
4
4
5
5
The designer itself needs plugins that tell it how to generate code for all the supported displays, input, and remote technologies. There are three plugins in the core set, and for 2.0 onwards they are packaged in the xmlPlugins folder of the tcMenu repository:
These plugins are always packaged with the designer and the designer will no longer update them as that causes more problems that it solves. If you prefer to build from source [using the packaging instructions](scripts/packager-all-platforms.md), in the case put the above plugins into "~/.tcmenu/plugins
Copy file name to clipboardExpand all lines: tcMenuGenerator/scripts/i18n-readme.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ In Java i18n is achieved using resource bundles. These are properties files that
4
4
5
5
There are several sets of files that control internationalisation, each of these is listed below:
6
6
7
-
* The menu designer resource bundles have text for the dialogs: https://github.com/davetcc/tcMenu/tree/master/tcMenuGenerator/src/main/resources/i18n
8
-
* The input and display plugin resource bundles - https://github.com/davetcc/tcMenu/tree/master/xmlPlugins/core-display/i18n
9
-
* The theme plugin resource bundles - https://github.com/davetcc/tcMenu/tree/master/xmlPlugins/core-themes/i18n
7
+
* The menu designer resource bundles have text for the dialogs: https://github.com/TcMenu/tcMenu/tree/main/tcMenuGenerator/src/main/resources/i18n
8
+
* The input and display plugin resource bundles - https://github.com/TcMenu/tcMenu/tree/main/xmlPlugins/core-display/i18n
9
+
* The theme plugin resource bundles - https://github.com/TcMenu/tcMenu/tree/main/xmlPlugins/core-themes/i18n
10
10
* The remote plugin has not yet been attempted, once it is internationalized, it will be added here.
11
11
12
12
The easiest way to test is to set your locale to the one you are working with, you can also switch locales in the designer, but it needs that locale to have been added to the general settings first as things stand. To do this add a new LocaleWithDescription to the list. Below is what the structure looks like now:
Copy file name to clipboardExpand all lines: zMedia/tcmenu-java-local-dev.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This guide is aimed at developers wanting to build the UI locally within an IDE.
7
7
* Java 20 OpenJDK runtime, you can use any that you wish. IMPORTANT you must use at least V20.
8
8
* OpenJFX, normally included from maven, if you don't use Liberica Full JDK, then you will need to adjust the designer pom.xml to bring in OpenJFX. See comments in pom.xml of each module.
9
9
* IntelliJ either community or ultimate should work. Use the latest one available.
10
-
* Local clone of the main repo from https://github.com/davetcc/tcMenu
10
+
* Local clone of the main repo from https://github.com/TcMenu/tcMenu
11
11
* If you want to build the JavaAPI via maven you will need the GPG tool installed
0 commit comments