From a49330b2fff4a4a9e960559807900e12959515d8 Mon Sep 17 00:00:00 2001 From: Dan Pascu <dan@ag-projects.com> Date: Tue, 8 Mar 2016 14:37:09 +0000 Subject: [PATCH] Updated docs --- doc/install.linux => INSTALL | 53 ++++++++++ MANIFEST.in | 3 +- doc/readme.txt => README | 17 +--- doc/changelog.html | 184 ----------------------------------- doc/install.windows | 53 ---------- doc/license.txt | 22 ----- 6 files changed, 56 insertions(+), 276 deletions(-) rename doc/install.linux => INSTALL (54%) rename doc/readme.txt => README (64%) delete mode 100644 doc/changelog.html delete mode 100644 doc/install.windows delete mode 100644 doc/license.txt diff --git a/doc/install.linux b/INSTALL similarity index 54% rename from doc/install.linux rename to INSTALL index 1bdae6d..a1bed98 100644 --- a/doc/install.linux +++ b/INSTALL @@ -95,3 +95,56 @@ debuild The .deb and related files are built in the upper directory. + +Blink Qt Installation on Microsoft Windows +------------------------------------------ + +Copyright (c) 2010-2014 AG Projects +http://ag-projects.com + +Home page: http://icanblink.com + +This document describes the installation procedure on Microsoft Windows +systems. Windows XP and higher are supported. + +This document assumes the SIP SIMPLE Client SDK has already been +installed alongside with all its dependencies. + + +Step 1. Install dependencies +---------------------------- + +* Install PyQt4: pacman -S mingw-w64-i686-python2-pyqt4 + +NOTE: at the time of this writing binary packages weren't available due to some work +in progress, they can alternatively be built manually. + + +Step 1.1. Install libvncclient +------------------------------ + +The MSYS2 project does not provide a package for libvncclient, and since our +needs are pretty specific, we provide the source to build a package which just +install the client side VNC libraries. + +* Install dependencies: pacman -S mingw-w64-i686-pkgconf patch +* Get the package code: darcs get http://devel.ag-projects.com/repositories/windows/mingw-w64-libvncclient +* Enter the directory and build the package: cd mingw-w64-libvncclient && makepkg-mingw -L --nocheck +* In case the above command fails with an error regarding a non-existent icon file, + just run "makepkg-mingw -L --nocheck" again +* Install the package: pacman -U mingw-w64-i686-libvncclient*any.pkg.tar.xz + + +Step 2. Build and run Blink +--------------------------- + +if [ -d blink-qt ]; then + cd blink-qt + darcs pull -a +else + darcs get --set-scripts-executable http://devel.ag-projects.com/repositories/blink-qt + cd blink-qt +fi +./build_inplace +./run + diff --git a/MANIFEST.in b/MANIFEST.in index 5dd442b..aa7195a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,6 @@ include LICENSE +include INSTALL +include README include MANIFEST.in include build_inplace @@ -8,6 +10,5 @@ include run recursive-include blink *.pyx recursive-exclude blink *.c -graft doc graft resources prune resources/icons/work diff --git a/doc/readme.txt b/README similarity index 64% rename from doc/readme.txt rename to README index b99ed70..7e4965f 100644 --- a/doc/readme.txt +++ b/README @@ -5,22 +5,7 @@ Blink This is the Qt version of Blink, a state of the art, easy to use SIP client for Linux and Microsoft Windows. -Copyright (c) 2010-2014 AG Projects -http://ag-projects.com - -Homepage: http://iCanBlink.com - - -License -------- - -Blink is licensed under GNU General Public License version 3. A copy of the -license is available at http://www.fsf.org/licensing/licenses/gpl-3.0.html - -The following restrictions apply: - - * You may not alter the name of the software (Blink) - * You may not alter the Copyright and About notices +Homepage: http://icanblink.com Features diff --git a/doc/changelog.html b/doc/changelog.html deleted file mode 100644 index 450b7db..0000000 --- a/doc/changelog.html +++ /dev/null @@ -1,184 +0,0 @@ -<html> -<head> -<title>Blink Qt Changelog</title> -<link rel='stylesheet' type='text/css' href='style.css'> -</head> - -<h2>Version 0.2.7</h2> - -<p>May 25th, 2011 - -<ul> -<li>Improved interoperability with OnSIP service -<li>Fixed duplicate account detection -<li>No longer decode display_name as it's unicode now -<li>Adapted to the latest API changes in middleware -<li>Fixed string representation of SIP URIs with special characters (SIP Simple) -<li>Fixed SDP negotiation on bogus answers (SIP Simple) -<li>Reduced SDP size when streams are disabled (SIP Simple) -</ul> - -<h2>Version 0.2.6</h2> - -<p>March 22nd, 2011 - -<ul> -<li>Fixed exception when NAT type detection is attempted without connectivity (SIP Simple) -<li>Fixed exceptions when contact URI can't be built for the desired route (SIP Simple) -<li>Fixed crashes and increased resilience when connectivity is lost (SIP Simple) -<li>Relax check on SDP origin to increase interoperability (SIP Simple) -</ul> - -<h2>Version 0.2.5</h2> - -<p>February 16th, 2011 - -<ul> -<li>Fixed saving TLS options (SIP Simple) -</ul> - -<h2>Version 0.2.4</h2> - -<p>February 15th, 2011 - -<ul> -<li>Added support for unicode device names -<li>Added menu entry and dialog for joining a conference -<li>Restructured main menu -<li>Improved DNS resolver capabilities (SIP Simple) -<li>Only handle records in the local. domain for bonjour (SIP Simple) -<li>Send 500 response if we fail to create incoming invitation (SIP Simple) -<li>Fixed race conditions in subscription handlers (SIP Simple) -<li>Fixed exception when the session is ended on error conditions (SIP Simple) -</ul> - -<h2>Version 0.2.3</h2> - -<p>December 14th, 2010 - -<ul> -<li>Detect change of IP address -<li>Added web server tools activity indicator -<li>Fixed compatibility with older python-qt -<li>Made changes to Preferences thread safe (SIP Simple) -<li>Fixed TLS transport initialization (SIP Simple) -<li>Added DNS resolver autodetection capabilities (SIP Simple) -<li>Fixed matching of media codecs on incoming calls (SIP Simple) -</ul> - -<h2>Version 0.2.2</h2> - -<p>November 29th, 2010 - -<ul> -<li>Fixed detection of audio codecs without a rtpmap line in SDP -<li>Fixed exception for MWI NOTIFY without a Message-Account body -</ul> - -<h2>Version 0.2.1</h2> - -<p>November 26th, 2010 - -<ul> -<li>Allow name and group attributes to be missing when updating a contact -<li>Handle bonjour neighbour record updates -<li>Updated debian dependency on python-sipsimple -<li>Honor the account.sip.always_use_my_proxy setting -<li>Fixed opening the create account dialog on first run -</ul> - -<h2>Version 0.2.0</h2> - -<p>November 11h, 2010 - -<ul> -<li>First Blink QT official release for MS Windows -<li>Added the preferences panel -<li>Enable inband DTMF by default -<li>Disable ICE by default -<li>Simplified MWI code and improved its user interface -<li>Improve handling of Google contacts -<li>Open the dialog for adding the initial account after the main window -<li>Switch to new plugged-in device automatically if we have active calls -<li>Added transparency for contact icons -<li>Added conference contact on first start -<li>Many bug fixes in the middleware -<li>Adapted to the latest changes in SIP SIMPLE client SDK -</ul> - -<h2>Version 0.1.4</h2> - -<p>September 6th, 2010 - -<ul> -<li>Save preferred media when creating a contact -<li>Fixed broken dependency to python-aplication for non-Debian systems -<li>Display 'no new messages' text before getting MWI NOTIFY -</ul> - -<h2>Version 0.1.3</h2> - -<p>September 3rd, 2010 - -<ul> -<li>Added support for inband DTMF dialing -<li>Improved logic for matching contacts to incoming sessions -<li>Added pstn prefix setting -<li>Fixed enabling Bonjour account item in the menu -<li>Added initial MWI support -</ul> - -<h2>Version 0.1.2</h2> - -<p>August 19th, 2010 - -<ul> -<li>First beta release for Microsoft Windows -<li>Switch automatically to the plugged audio device -<li>Release notes available at http://icanblink.com/blink-qt-windows-beta.phtml -</ul> - -<h2>Version 0.1.1</h2> - -<p>August 13th, 2010 - -<ul> -<li>First public release for Debian and Ubuntu Linux -<li>Release notes available at http://icanblink.com/blink-qt-beta.phtml -<li>Multiple SIP accounts -<li>Easy to setup accounts, only the SIP address and password are required -<li>Bonjour discovery mechanism -<li>Automatic detection of IP address changes -<li>TLS Security for both signaling and media -<li>NAT traversal using ICE -<li>Built-in DNS resolver to by-pass broken implementations in NAT routers -<li>Re-INVITE support for adding and removing media streams -<li>One-click SIP account sign-up at http://sip2sip.info -<li>Integration with AG Projects Multimedia Service Platform -<li>Integration with third-party SIP service providers -<li>Wideband Audio (G722 & speex) -<li>Multiple parallel calls -<li>Play hold tone and disconnect tone -<li>In-band DTMF support for legacy devices -<li>Per account ringtones -<li>Silent mode (do not ring on incoming call) -<li>Mute microphone -<li>Displays packet loss and round trip time -<li>Displays selected audio codec and sampling rate -<li>Control for input, output and alert audio devices -<li>Automatic DTMF mapping between letters and digits -<li>Support for entering PSTN numbers and SIP addresses -<li>Strip unwanted characters from telephone numbers -<li>Redial last call -<li>Multi-party conferencing with unlimited number of participants -<li>Multiple simultaneous conferences -<li>Drag and Drop contacts to conferences -<li>Mute individual participants -<li>Audio recording -<li>Display the caller icon and name retrieved from Address Book -<li>Reject calls with 486 Busy or 603 Decline -<li>SIP, DNS, MSRP protocol trace to file -</ul> - -</body> -</html> diff --git a/doc/install.windows b/doc/install.windows deleted file mode 100644 index 096fd61..0000000 --- a/doc/install.windows +++ /dev/null @@ -1,53 +0,0 @@ - -Blink Qt Installation on Microsoft Windows ------------------------------------------- - -Copyright (c) 2010-2014 AG Projects -http://ag-projects.com - -Home page: http://icanblink.com - -This document describes the installation procedure on Microsoft Windows -systems. Windows XP and higher are supported. - -This document assumes the SIP SIMPLE Client SDK has already been -installed alongside with all its dependencies. - - -Step 1. Install dependencies ----------------------------- - -* Install PyQt4: pacman -S mingw-w64-i686-python2-pyqt4 - -NOTE: at the time of this writing binary packages weren't available due to some work -in progress, they can alternatively be built manually. - - -Step 1.1. Install libvncclient ------------------------------- - -The MSYS2 project does not provide a package for libvncclient, and since our -needs are pretty specific, we provide the source to build a package which just -install the client side VNC libraries. - -* Install dependencies: pacman -S mingw-w64-i686-pkgconf patch -* Get the package code: darcs get http://devel.ag-projects.com/repositories/windows/mingw-w64-libvncclient -* Enter the directory and build the package: cd mingw-w64-libvncclient && makepkg-mingw -L --nocheck -* In case the above command fails with an error regarding a non-existent icon file, - just run "makepkg-mingw -L --nocheck" again -* Install the package: pacman -U mingw-w64-i686-libvncclient*any.pkg.tar.xz - - -Step 2. Build and run Blink ---------------------------- - -if [ -d blink-qt ]; then - cd blink-qt - darcs pull -a -else - darcs get --set-scripts-executable http://devel.ag-projects.com/repositories/blink-qt - cd blink-qt -fi -./build_inplace -./run - diff --git a/doc/license.txt b/doc/license.txt deleted file mode 100644 index eee1b5e..0000000 --- a/doc/license.txt +++ /dev/null @@ -1,22 +0,0 @@ -Copyright (c) 2009-2015 AG Projects http://ag-projects.com - -Blink License - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "AS IS" AND ANY EXPRESS -OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES -OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN -NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, -INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, -OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, -EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -Blink is licensed under GNU General Public License version 3. A copy of the -license is available at http://www.fsf.org/licensing/licenses/gpl-3.0.html - -The following restrictions apply: - - * You may not alter the name of the software (Blink) - * You may not alter the Copyright and About notices -- 2.21.0