summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/tlcockpit/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/tlcockpit/README.md')
-rw-r--r--Master/texmf-dist/doc/support/tlcockpit/README.md81
1 files changed, 81 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/tlcockpit/README.md b/Master/texmf-dist/doc/support/tlcockpit/README.md
new file mode 100644
index 00000000000..bd806ba995e
--- /dev/null
+++ b/Master/texmf-dist/doc/support/tlcockpit/README.md
@@ -0,0 +1,81 @@
+TLCockpit - GUI frontend to tlmgr
+=================================
+
+TLCockpit aims at being a GUI for [tlmgr](https://www.tug.org/texlive/tlmgr.html), the [TeX Live](https://www.tug.org/texlive/) Manager, with a modern look and feel.
+
+TLCockpit is included in TeX Live, but you need the latest version of tlmgr, see the secion on <em>Test versions</em> in the above document.
+
+Supported functionality
+-----------------------
+
+By now only loading of remote repository, listing installed, updated,
+or all packages. Clicking on a package in the list opens a details
+window.
+
+Furthermore, an input field allows entering arbitrary commands of the
+*tlmgr shell*, see [tlmgr manual](https://www.tug.org/texlive/doc/tlmgr.html#shell) for details.
+
+Installing/Running
+------------------
+
+If you don't want to build your own deployment jar (which I don't recommend),
+download [tlcockpit.jar](jar/tlcockpit.jar) and run it with
+
+```
+java -jar tlcockpit.jar
+```
+
+The `tlmgr` program has to be in the PATH, and be the most current version.
+
+Requirements
+------------
+A recent Java installation that included JavaFX is required. If you see
+errors like
+```
+Error: A JNI error has occurred, please check your installation and try again
+Exception in thread "main" java.lang.NoClassDefFoundError: javafx/event/EventTarget
+ at java.lang.ClassLoader.defineClass1(Native Method)
+ at java.lang.ClassLoader.defineClass(ClassLoader.java:763)
+...
+```
+that means that the Java installation does not provides JavaFX.
+
+On Windows the latest JRE from Oracle include JavaFX. On Linux one might
+need to install some extra packages (Debian/Ubuntu: openjfx).
+
+Development
+-----------
+
+Development is done in Scala with the ScalaFX widget set. The project is
+mainly a challenge for myself to learn Scala. Building is done with *sbt*,
+opening the project in IntelliJ works fine.
+
+Deplyment is done via [sbt assembly](https://github.com/sbt/sbt-assembly)
+which packs all the necessary libraries into one jar file.
+
+Contributions are welcome, improvements are easily done as I just started
+writing Scala and my style is horrible ;-)
+
+Screenshots
+-----------
+
+Main window
+
+![Main window](screenshots/mainwindow.png)
+
+Package details
+
+![Package details](screenshots/pkg-details.png)
+
+
+License
+-------
+
+GPL3+
+
+
+Author
+------
+
+Norbert Preining
+