summaryrefslogtreecommitdiff
path: root/support/tlcockpit/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/tlcockpit/README.md
Initial commit
Diffstat (limited to 'support/tlcockpit/README.md')
-rw-r--r--support/tlcockpit/README.md123
1 files changed, 123 insertions, 0 deletions
diff --git a/support/tlcockpit/README.md b/support/tlcockpit/README.md
new file mode 100644
index 0000000000..c5b9bbd8d2
--- /dev/null
+++ b/support/tlcockpit/README.md
@@ -0,0 +1,123 @@
+TLCockpit - GUI frontend to tlmgr
+=================================
+
+<img align="right" width="100" height="100" src="src/main/resources/TLCockpit/tlcockpit-128.jpg">
+
+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.
+We take inspiration from the [TeX Live Utility](http://amaxwell.github.io/tlutility/).
+
+
+Installing/Running
+------------------
+
+Since TLCockpit is included in TeX Live, it will be probably already installed
+on your system. In case it isn't, a simple call to `tlmgr install tlcockpit`
+should suffice.
+
+We are providing new jar files on the github page, but update
+the copy in TeX Live only at certain intervals. If you want to try out the latest
+and greatest, get [tlcockpit.jar](jar/tlcockpit.jar) and put it into
+`TEXLIVEROOT/texmf-dist/scripts/tlcockpit` replacing the current `tlcockpit.jar`.
+
+After this you can run it by simply typing `tlcockpit`, or via a direct `java`
+call as in `java -jar PATH/TO/tlcockpit.jar`.
+
+Debugging can be enabled by passing the option `-d` or, for more detailed debugging `-dd`.
+
+Requirements
+------------
+You need at least `tlmgr` from after 2017-11-23, in TeX Live language at least
+version 45888 or `texlive.infra`.
+
+A recent Java (at least Java 8) installation that includes 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).
+
+With recent release of Java 11 problems are getting worse, since JavaFX is now
+separately packaged, and ScalaFX only supports (by now) JavaFX8. That means, for
+now it is necessary to have a Java 8 installation. As soon as ScalaFX supports
+JavaFX11 we will move to use it.
+
+
+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.
+
+Deployment 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
+-----------
+
+Starting up TLCockpit
+
+![Loading screen](screenshots/tlcockpit-loading.jpg)
+
+Package listing
+
+![Package listing view](screenshots/tlcockpit-packages.jpg)
+
+View packages by collections
+
+![Packages by collections](screenshots/tlcockpit-collections.jpg)
+
+Updates listing, with one package being updated
+
+![Updates listing view](screenshots/tlcockpit-updates.jpg)
+
+After updating all packages during the run of postactions like `mktexlsr`
+
+![Postaction view](screenshots/tlcockpit-postactions.jpg)
+
+Backup/Restore listing
+
+![Backup listing view](screenshots/tlcockpit-backups.jpg)
+
+Package details
+
+![Package details](screenshots/tlcockpit-pkgdetails.jpg)
+
+Configuration dialog
+
+![Config screen](screenshots/tlcockpit-config.jpg)
+
+Repository seup dialog with dropdown for mirror selection
+
+![Repository screen](screenshots/tlcockpit-repositories.jpg)
+
+Paper setting dialog
+
+![Config screen](screenshots/tlcockpit-paper.jpg)
+
+The Tools menu, as well as the expert and debug panes open
+
+![Menu, Expert, Debug](screenshots/tlcockpit-menu-debug-expert.jpg)
+
+License
+-------
+
+GPL3+
+
+
+Author
+------
+
+Norbert Preining
+