diatoming / textual Goto Github PK

Textual is an application for interacting with Internet Relay Chat (IRC) on OS X. Much of the app uses the open standard of WebKit which makes customization easy through the use of CSS 3 and HTML 5. Plugins written in Objective-C and scripts made with AppleScript (and other languages) are also supported.

Forked from the project LimeChat in 2010, Textual has since evolved into one of the most popular applications for interacting with IRC on OS X.

Those wishing to support Textual can buy a copy of it on the Mac App Store or directly through FastSpring for 4.99 USD (plus applicable sales tax).

Please do not abuse the power to build Textual in order to freely distribute it to hundreds of users. The copy of Textual in the Mac App Store helps fund the project. Therefore, what is asked, is asked out of respect so that the project can continue to thrive.

Please be aware that while it is within your right to compile Textual, we will not provide support for the building process as it encourages use of potentially unstable code. If you do succeed in building Textual, then you will not be turned away when asking for support using the application itself.

Textual is dependent on several other projects to build. This repository is automatically linked against these other projects using what are known as "submodules" — Clicking the "Download ZIP" button to build a copy of Textual will not download a copy of these projects that Textual depends on. Therefore, to properly build Textual, Textual must be cloned using Github for Mac or by using the following commands in Terminal:

git clone https://github.com/Codeux-Software/Textual.git Textual
cd Textual
git submodule update --init --recursive

Failing to follow these steps will result in several "file not found" errors resulting in the inability for Textual to successfully build.

It is HIGHLY DISCOURAGED to turn off code signing. Certain features rely on the fact that Textual is properly signed and is within a sandboxed environment.

TEXTUAL DOES NOT REQUIRE A CERTIFICATE ISSUED BY APPLE TO BUILD which means there is absolutely no reason to turn code signing off.

To avoid patch files and/or a separate repository; the code which is responsible for licensing paid copies of Textual is in the source code that you download from here.

If you do not have a license key, then set the TEXTUAL_BUILT_WITH_LICENSE_MANAGER flag to 0 in the Standard Release configuration file to disable the inclusion of this code at build time.

The latest version of Textual requires two things to be built. One is a valid (does not need to be issued by Apple) code signing certificate. The second is an installation of Xcode 6.1 or newer on OS X Yosemite. Building on OS X Mavericks and earlier is not possible.

If you are an Apple registered developer, then obtaining a signing certificate is not very difficult. However, if you are not, a self-signed certificate for "code signing" will work fine. The steps to produce one of these self-signed certificates is very simple to find using Google.

Once you have your code signing certificate, do not modify the Build Settings of Textual through Xcode. Instead, modify the file at the path: Resources ➜ Build Configurations ➜ Code Signing Identity.xcconfig — The contents of this file define the name of the certificate which will be used for code signing.

After defining your code signing certificate, build Textual using the "Standard Release" build scheme.

When you build Textual for the first time, a framework that Textual that is dependent on (Encryption Kit) will download several open source libraries (libgpg-error, libgcrypt, and libotr) from the Internet which means if you do not have an active Internet connection, these files will not download and the build will fail.

The build process can take up to a minute or more to complete because in addition to building Textual itself, Xcode has to build these open source libraries as well.

If the build succeeds and it typically will, then the final product can be found in the Build Results folder located at the root path of the project.

The source code of Limechat did not fall under its current GPL license at the time that the source code was forked in 2010. Its original license, at the time of the fork, is displayed below:

The New BSD License

Copyright (c) 2008 - 2010 Satoshi Nakagawa < psychs AT limechat DOT net >
All rights reserved. 

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 AUTHOR OR CONTRIBUTORS 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.

Textual has indirectly incorporated work from several open source projects. Acknowledgement of these can be found in the respective files that were contributed including licensing information for distribution.

Work that originated from the authors of Textual and were not contributed by other open source projects or from Limechat itself fall under the following license:

Copyright (c) 2010 - 2015 Codeux Software, LLC & respective contributors.
      Please see Acknowledgements.pdf for additional information.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
   * Neither the name of Textual and/or "Codeux Software, LLC", nor the 
     names of its contributors may be used to endorse or promote products 
     derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 AUTHOR OR CONTRIBUTORS 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.