From b5633492dc4bc09fa189ddb9d47b7476c755b554 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Richarz?= Date: Sat, 11 Apr 2026 04:35:35 +0200 Subject: [PATCH] polished installation docs for Linux --- README.md | 24 +++++++++------------- docs/raspberrypi.md | 49 ++++++++++++++++++++++++++------------------- raspberrypi.txt | 11 +++++----- 3 files changed, 43 insertions(+), 41 deletions(-) mode change 100755 => 100644 README.md mode change 100755 => 100644 docs/raspberrypi.md diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 50ecf8e..a702b9f --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Tek4010 Emulator -![Tek4010 example](docs/images/screendump.png) - Tek4010 is an emulator for Tektronix 4010/4014 graphics terminals. It reproduces the behavior of the original storage tube display, including realistic drawing speed @@ -10,31 +8,33 @@ and the true fading of the drawing spot over time. This makes it possible to experience historical plot files and legacy Unix systems as they originally behaved. +![Tek4010 example](docs/images/screendump.png) + --- ## Installation Choose your platform: -- Raspberry Pi / Linux → raspberrypi.txt -- macOS → macos.txt -- Windows (WSL) → windows.txt +- Raspberry Pi / Linux → [raspberrypi.txt](raspberrypi.txt) +- macOS → [macos.txt](macos.txt) +- Windows (WSL) → [windows.txt](windows.txt) These files contain a short and simple installation guide. More detailed instructions are available in: -- docs/raspberrypi.md -- docs/macos.md -- docs/windows-wsl.md +- [docs/raspberrypi.md](docs/raspberrypi.md) +- [docs/macos.md](docs/macos.md) +- [docs/windows-wsl.md](docs/windows-wsl.md) --- ## Quick test -After installation, run: +After installation, run in your Tek4010 directory: - tek4010 -noexit cat test.plt + make test You should see a graphical display. @@ -64,7 +64,3 @@ Examples and demo files are included in the repository: This emulator is designed to support historical Unix environments and related hardware projects such as PiDP-11 systems. - -This makes it possible to experience historical plot -files and legacy Unix systems as they originally behaved. - diff --git a/docs/raspberrypi.md b/docs/raspberrypi.md old mode 100755 new mode 100644 index 6b628b8..c9dfb2b --- a/docs/raspberrypi.md +++ b/docs/raspberrypi.md @@ -9,43 +9,43 @@ The same steps usually work on other Linux systems. Open a terminal and install required packages: +``` sudo apt-get update sudo apt-get install git libgtk-3-dev make gcc pkg-config +``` Download the source code: +``` git clone https://github.com/rricharz/Tek4010 cd Tek4010 +``` Build and install: +``` make clean make make install - -If this is your first installation, you may reboot: - -sudo reboot - ---- +``` ## First test -Go to the directory containing test.plt and run: +Run the following while you are in the Tek4010 directory: -tek4010 -noexit cat test.plt +``` +make check +``` -You should see a graphical display. - -The display speed can be adjusted if needed. +This runs a demonstration and verifies that tek4010 works. --- ## Examples -Additional examples are available in the repository: +Many additional examples are available in the tek4010 directory: -- demos/demo.sh +- demos/ - pltfiles/ - ardsfiles/ @@ -53,19 +53,25 @@ Additional examples are available in the repository: ## Notes -Keeping the window open: +### Running tek4010 -The option -noexit keeps the window open after the command has finished. +See the quick start guide: -Remote systems: +- [docs/quickstart.md](quickstart.md) -When connecting to historical Unix systems, you may need rsh or telnet: +### Remote systems +When connecting to historical Unix systems, you may need: + +``` sudo apt-get install rsh-client +``` -or +or: +``` sudo apt-get install telnet +``` --- @@ -73,13 +79,14 @@ sudo apt-get install telnet - The program is built using make - make install installs the binary in a user-local location -- Ensure that this location is included in your PATH Manual build steps: +``` make clean make make install +``` -If the system changes in the future, adapt package installation -and build commands as required. +If the system changes in the future, adapt package +installation and build commands as required. diff --git a/raspberrypi.txt b/raspberrypi.txt index 3ffed0b..54b8b7d 100644 --- a/raspberrypi.txt +++ b/raspberrypi.txt @@ -22,14 +22,13 @@ Quick start: make make install -4. Test: +4. Check installation while you are still in the + Tek4010 directory: - tek4010 -noexit cat test.plt + make check -You should see a graphical display. +This runs a demonstration and verifies that tek4010 works. -The display speed can be adjusted if needed. - -For full instructions, demos, and additional options, see: +For full instructions and additional information, see: docs/raspberrypi.md \ No newline at end of file