From 21f8d41d257730458e1ce1eeca981ca166d804ff Mon Sep 17 00:00:00 2001 From: David Griffith Date: Wed, 21 Mar 2018 07:37:25 -0700 Subject: [PATCH] Increased README.md's verbosity and added build instructions. --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 57 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3d45609..3840a10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,58 @@ -TL866 -===== +# TL866 +Open source firmware and utilities for Minipro TL866xx series of chip programmers + +This project's scope is dealing with the firmware within the TL866 +itself. It includes software for dumping, reprogramming, and +manipulating the firmware. Schematics and discussion of internal +operations are also here. + +These programs are not for using the TL866 to read and write chips. Use +https://github.com/vdudouyt/minipro for that. + + +## Installation of the TL866 Updater on Linux + +### Install build dependencies + +#### Debian/Ubuntu +```nohighlight +sudo apt-get install build-essential pkg-config git libusb-1.0-0-dev libqt4-dev +``` + +### Checkout source code and compile +```nohighlight +git clone https://github.com/radiomanV/TL866 +cd TL866/QT +qmake +make +sudo cp TL866_Updater /usr/local/bin +``` + +### Udev configuration (recommended) +If you want to access the programmer as a regular user, you'll have to +configure udev to recognize the programmer and set appropriate access +permissions. These are the same rules as are available with +https://github.com/vdudouyt/minipro. If you already installed the rules +there, you don't need to do it again here. + +#### Debian/Ubuntu +```nohighlight +sudo cp udev/debian/60-minipro.rules /etc/udev/rules.d/ +sudo udevadm trigger +``` +You'll also have to add your regular user to the `plugdev` system +group: +```nohighlight +sudo usermod -a -G plugdev YOUR-USER +``` +Note that this change will only become effective after your next +login. + +#### CentOS 7 +```nohighlight +sudo cp udev/centos7/80-minipro.rules /etc/udev/rules.d/ +sudo udevadm control --reload-rules +``` +The CentOS rules file currently make the programmer device writable for +all users. -Open source software for TL866