polished the macintosh installation

docs/macos.md

@@ -0,0 +1,94 @@
+# Tek4010 on macOS
+
+This page describes installation on macOS.
+
+---
+
+## Quick installation
+
+Open a terminal and install required tools:
+
+```
+xcode-select --install
+```
+
+Install MacPorts from:
+
+https://macports.org/install.php
+
+Reboot your Mac.
+
+Install required packages:
+
+```
+sudo port install gtk3-devel git cairo pkgconfig
+```
+
+Install XQuartz from:
+
+https://xquartz.org
+
+Download the source code:
+
+```
+git clone https://github.com/rricharz/Tek4010
+cd Tek4010
+```
+
+Build and install:
+
+```
+make clean
+make
+make install
+```
+
+---
+
+## First test
+
+Run:
+
+```
+make check
+```
+
+This runs a demonstration and verifies that tek4010 works.
+
+---
+
+## Alternative using Homebrew
+
+Instead of MacPorts, you can use Homebrew:
+
+```
+brew install gtk+3 git cairo pkgconfig
+```
+
+---
+
+## Notes
+
+### Running tek4010
+
+See the quick start guide:
+
+- [docs/quickstart.md](quickstart.md)
+
+---
+
+## For experienced users
+
+- The program is built using make
+- make install installs the binary in a user-local location
+
+Manual build steps:
+
+```
+make clean
+make
+make install
+```
+
+If the system changes in the future, adapt package
+installation and build commands as required.

macintosh.txt

@@ -1,55 +0,0 @@
-Tek4010 on macOS
-================
-
-tek4010 can also be built on macOS. If you are prepared to
-use the command line interface, proceed as follows. See note
-at the bottom if you are using brew.
-
-Open a terminal window and type
-
-1. xcode -select --install
-
-2. Install MacPorts. See https://macports.org/install.php
-
-3. Reboot your Mac 
-
-Type the following commands in your terminal window:
-
-4. sudo port install gtk3-devel
-
-5. sudo port install git
-
-6. sudo port install cairo
-
-7. sudo port install pkgconfig
-
-8. Install XQuartz, see https://xquartz.org
-
-9. git clone https://github.com/rricharz/Tek4010
-
-10. cd Tek4010
-
-11. make clean
-
-12. make
-
-13. make install
-
-14. Add PATH="$HOME/.local/bin:$PATH" to your ~/.zprofile file
-
-15. Reboot your PC
-
-16. Test with
-        cd Tek4010
-        make check
-
-There are a few minor problems at present, see the
-issues in the github repository
-
-Note: Thanks to Clem Cole pointed out that users of brew
-instead of MacPorts can replace steps 2 to 7 as follows
-
-  4. brew install gtk+3
-  5. brew install git
-  6. brew install cairo
-  7. brew install pkgconfig

macos.txt

@@ -0,0 +1,42 @@
+Tek4010 on macOS
+=================
+
+This is a quick installation guide for macOS.
+
+Quick start:
+
+1. Open a terminal and type:
+
+   xcode-select --install
+
+2. Install MacPorts. See https://macports.org/install.php
+
+3. Reboot your Mac
+
+4. Install required packages:
+
+   sudo port install gtk3-devel git cairo pkgconfig
+
+5. Install XQuartz. See https://xquartz.org
+
+6. Download the source:
+
+   git clone https://github.com/rricharz/Tek4010
+   cd Tek4010
+
+7. Build and install:
+
+   make clean
+   make
+   make install
+
+8. Check installation while you are still in the
+   Tek4010 directory:
+
+   make check
+
+This runs a demonstration and verifies that tek4010 works.
+
+For full instructions and additional information, see:
+
+   docs/macos.md