very early checkin of template for user-docs, only a few pages filled out

18 files changed, 229 insertions, 0 deletions

diff --git a/docs/about/license.md b/docs/about/license.md
new file mode 100644
index 00000000..642535d5
--- /dev/null
+++ b/docs/about/license.md
@@ -0,0 +1,79 @@
+# License
+
+Binary Ninja comes in different versions. Depending on the terms under which you purchased it, a different license below may apply. 
+
+## Personal License
+
+IMPORTANT! BE SURE TO CAREFULLY READ AND UNDERSTAND ALL OF THE TERMS SET FORTH IN THIS LICENSE AGREEMENT (”LICENSE”). BY CLICKING THE "I ACCEPT" BUTTON OR OTHERWISE ACCEPTING THIS LICENSE THROUGH AN ORDERING DOCUMENT THAT INCORPORATES THIS LICENSE, YOU AGREE TO FOLLOW AND BE BOUND BY THE TERMS AND CONDITIONS OF THIS LICENSE. IF YOU DO NOT AGREE TO ALL THE TERMS AND CONDITIONS IN THIS LICENSE, YOU MUST SELECT THE "I DECLINE" BUTTON AND MAY NOT USE THE SOFTWARE.  
+
+This License is entered into by and between you (“you” or “your”) and Vector 35 LLC, a Florida limited liability company (“us,” “we” or “our”).
+
+We will license Binary Ninja™, a software application (the “Software”), to you under the mutual terms and conditions in this License.  By installing the Software, you agree to be bound by the terms of this License. If you do not agree to the terms of this License, please do not install or attempt to use the Software.
+
+1.	Non-Exclusive License Grant for Non-commercial Use. Under the terms of this License, the Software is licensed on a non-exclusive basis and is not sold. This License is for non-commercial purposes only. This means that you may not exercise any of the rights granted to you under this License in any manner that is intended for or directed toward commercial advantage or private monetary gain such as (a) activities undertaken for profit, or (b) activities intended to produce works, services, or data for commercial use, or (c) activities conducted, or funded, by a person or an entity engaged in the commercial use, application or exploitation of works similar to the Software. If you have any question regarding a particular use, please feel free to contact us regarding your particular circumstances. Please note, the Software under this non-commercial license is a different version than the standard version of Binary Ninja™. There is a fee to upgrade to the standard version of Binary Ninja™. This License grants you the rights a single user license that allows a copy of the Software to be installed and used by you on other computers you own as a single designated person. In other words, you may install the Software on more than one computer owned by you as long as there is only one physical computer running the Software at any time and as long as it is only used by you. This License does not permit any concurrent use. If other users will use the Software on any of the computers that the application will be installed on, then you are required to obtain additional licenses for each user who plans to use the Software. If your needs require concurrent use, please contact us for alternative licensing arrangements. We reserve all rights not expressly granted in this License.
+
+2.	License Fee. Prices are subject to change without prior notice and the price of a License today does not guarantee a similar price in the future.
+
+3.	Termination.  Your license to the Software automatically terminates if you fail to comply with the terms of this License. Upon termination of this License, all licenses granted in Section 1 will terminate and you are required to stop using the Software and delete all copies in your possession or control. The following provisions will survive termination of this License: (i) your obligation to pay for services rendered before termination; (ii) Sections 6 through 14; and (iii) any other provision of this License that must survive termination to fulfill its essential purpose.
+
+4.	Modification and Upgrades. We may, from time to time, and in certain cases for a fee, replace, modify or upgrade the Software. The license fee includes one year of free upgrades. When accepted by you, any such replacement or modified Software code or upgrade to the Software will be considered part of the Software and subject to the terms of this License (unless this License is superseded by a further License accompanying such replacement or modified version of or upgrade to the Software).
+
+5.	Restrictions. You are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from, distribute or provide others with the Software in whole or part, or transmit or communicate the any of the Software over a network in order to share it with others.
+
+6.	Export Restrictions. You must use the Software in accordance with export laws and this means that you may not export, ship, transmit or re-export the Software, in whole or in part, in violation of any applicable law or regulation including but not limited to applicable export administration regulations issued by the U.S. Department of Commerce.
+
+7.	Disclaimer of Warranties. The Software is provided "as is" which means that we are providing no warranty of any kind. WE MAKE NO WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. We do not warrant that the Software will perform without error or that it will run without interruption.
+
+8.	Limitation of Liability.  IN NO EVENT WILL OUR LIABILITY ARISING OUT OF OR RELATED TO THIS LICENSE EXCEED THE AGGREGATE OF FEES PAYABLE TO US UNDER THIS LICENSE (INCLUDING FEES BOTH PAID AND DUE) AT THE TIME OF THE EVENT GIVING RISE TO THE LIABILITY. IN NO EVENT WILL WE BE LIABLE FOR ANY CONSEQUENTIAL, INDIRECT, SPECIAL, INCIDENTAL, OR PUNITIVE DAMAGES. THE LIABILITIES LIMITED BY THIS SECTION 8 APPLY: (A) TO LIABILITY FOR NEGLIGENCE; (B) REGARDLESS OF THE FORM OF ACTION, WHETHER IN CONTRACT, TORT, STRICT PRODUCT LIABILITY, OR OTHERWISE; (C) EVEN IF WE ARE ADVISED IN ADVANCE OF THE POSSIBILITY OF THE DAMAGES IN QUESTION AND EVEN IF SUCH DAMAGES WERE FORESEEABLE; AND (D) EVEN IF YOUR REMEDIES FAIL OF THEIR ESSENTIAL PURPOSE. If applicable law limits the application of the provisions of this Section 8, our liability will be limited to the maximum extent permissible.
+
+9.	Severability. To the extent permitted by law, we waive and you waive any provision of law that would render any clause of this License invalid or otherwise unenforceable in any respect. In the event that a provision of this License is held to be invalid or otherwise unenforceable, such provision will be interpreted to fulfill its intended purpose to the maximum extent permitted by applicable law, and the remaining provisions of this License will continue in full force and effect.
+
+10.	Independent Contractors. We are not your agent and you are not our agent and so neither party may bind the other in any way. The parties are independent contractors and will represent themselves in all regards as independent contractors.
+
+11.	No Waiver. Neither party will be deemed to have waived any of its rights under this License by lapse of time or by any statement or representation other than in an explicit written waiver. No waiver of a breach of this License will constitute a waiver of any prior or subsequent breach of this License.
+
+12.	Force Majeure. To the extent caused by force majeure, no delay, failure, or default will constitute a breach of this License.  
+
+13.	Assignment & Successors. Neither party may assign this License or any of its rights or obligations hereunder without the other’s express written consent, except that either party may assign this License to the surviving party in a merger of that party into another entity. Except to the extent forbidden in the previous sentence, this License will be binding upon and inure to the benefit of the respective successors and assigns of the parties.
+
+14.	Choice of Law & Jurisdiction. This License will be governed solely by the internal laws of the State of Florida, without reference to such State’s principles of conflicts of law. The parties consent to the personal and exclusive jurisdiction of the federal and state courts in or for Brevard County, Florida.
+
+## Commercial License
+
+IMPORTANT! BE SURE TO CAREFULLY READ AND UNDERSTAND ALL OF THE TERMS SET FORTH IN THIS LICENSE AGREEMENT ("LICENSE"). BY CLICKING THE "I ACCEPT" BUTTON OR OTHERWISE ACCEPTING THIS LICENSE THROUGH AN ORDERING DOCUMENT THAT INCORPORATES THIS LICENSE, YOU AGREE TO FOLLOW AND BE BOUND BY THE TERMS AND CONDITIONS OF THIS EULA. IF YOU ARE ENTERING INTO THIS EULA ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THE TERMS AND CONDITIONS OF THIS EULA AND, IN SUCH EVENT, "YOU" AND "YOUR" AS USED IN THIS EULA SHALL REFER TO SUCH ENTITY, IF YOU DO NOT HAVE SUCH AUTHORITY, OR IF YOU DO NOT AGREE TO ALL THE TERMS AND CONDITIONS IN THIS LICENSE, YOU MUST SELECT THE "I DECLINE" BUTTON AND MAY NOT USE THE SOFTWARE.  
+
+This License is entered into by and between you ("you" or "your") and Vector 35 LLC, a Florida limited liability company ("us", "we" or "our").
+
+We will license Binary Ninja™, a software application (the "Software"), to you under the mutual terms and conditions in this License.  By installing the Software, you agree to be bound by the terms of this License. If you do not agree to the terms of this License, please do not install or attempt to use the Software.
+
+1.	Non-Exclusive License Grant. Under the terms of this License, the Software is licensed on a non-exclusive basis and is not sold. You receive no title to or ownership of the Software itself. This License grants you the rights to a single user license that allows a copy of the Software to be installed and used with the single computer of only one designated person. This License does not permit any concurrent use. If other users will use the Software, then you are required to obtain additional licenses for each user who plans to use the Software. All rights not expressly granted herein reserved by us.
+
+2.	License Fee. Prices are subject to change without prior notice and the price of a License today does not guarantee a similar price in the future.
+
+3.	Termination.  Your license to the Software automatically terminates if you fail to comply with the terms of this License. Upon termination of this License, all licenses granted in Section 1 will terminate and you are required to stop using the Software and delete all copies in your possession or control. The following provisions will survive termination of this License: (i) your obligation to pay for services rendered before termination; (ii) Sections 6 through 14; and (iii) any other provision of this License that must survive termination to fulfill its essential purpose.
+
+4.	Modification and Upgrades. We may, from time to time, and in certain cases for a fee, replace, modify or upgrade the Software. The license fee includes one year of free upgrades. When accepted by you, any such replacement or modified Software code or upgrade to the Software will be considered part of the Software and subject to the terms of this License (unless this License is superseded by a further License accompanying such replacement or modified version of or upgrade to the Software).
+
+5.	Restrictions. You are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from, distribute or provide others with the Software in whole or part, or transmit or communicate the any of the Software over a network in order to share it with others.
+
+6.	Export Restrictions. You must use the Software in accordance with export laws and this means that you may not export, ship, transmit or re-export the Software, in whole or in part, in violation of any applicable law or regulation including but not limited to applicable export administration regulations issued by the U.S. Department of Commerce.
+
+7.	Disclaimer of Warranties. The Software is provided "as is" which means that we are providing no warranty of any kind. WE MAKE NO WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. We do not warrant that the Software will perform without error or that it will run without interruption.
+
+8.	Limitation of Liability.  IN NO EVENT WILL OUR LIABILITY ARISING OUT OF OR RELATED TO THIS LICENSE EXCEED THE AGGREGATE OF FEES PAYABLE TO US UNDER THIS LICENSE (INCLUDING FEES BOTH PAID AND DUE) AT THE TIME OF THE EVENT GIVING RISE TO THE LIABILITY. IN NO EVENT WILL WE BE LIABLE FOR ANY CONSEQUENTIAL, INDIRECT, SPECIAL, INCIDENTAL, OR PUNITIVE DAMAGES. THE LIABILITIES LIMITED BY THIS SECTION 8 APPLY: (A) TO LIABILITY FOR NEGLIGENCE; (B) REGARDLESS OF THE FORM OF ACTION, WHETHER IN CONTRACT, TORT, STRICT PRODUCT LIABILITY, OR OTHERWISE; (C) EVEN IF WE ARE ADVISED IN ADVANCE OF THE POSSIBILITY OF THE DAMAGES IN QUESTION AND EVEN IF SUCH DAMAGES WERE FORESEEABLE; AND (D) EVEN IF YOUR REMEDIES FAIL OF THEIR ESSENTIAL PURPOSE. If applicable law limits the application of the provisions of this Section 8, our liability will be limited to the maximum extent permissible.
+
+9.	Severability. To the extent permitted by law, we waive and you waive any provision of law that would render any clause of this License invalid or otherwise unenforceable in any respect. In the event that a provision of this License is held to be invalid or otherwise unenforceable, such provision will be interpreted to fulfill its intended purpose to the maximum extent permitted by applicable law, and the remaining provisions of this License will continue in full force and effect.
+
+10.	Independent Contractors. We are not your agent and you are not our agent and so neither party may bind the other in any way. The parties are independent contractors and will represent themselves in all regards as independent contractors.
+
+11.	No Waiver. Neither party will be deemed to have waived any of its rights under this License by lapse of time or by any statement or representation other than in an explicit written waiver. No waiver of a breach of this License will constitute a waiver of any prior or subsequent breach of this License.
+
+12.	Force Majeure. To the extent caused by force majeure, no delay, failure, or default will constitute a breach of this License.  
+
+13.	Assignment & Successors. Neither party may assign this License or any of its rights or obligations hereunder without the other’s express written consent, except that either party may assign this License to the surviving party in a merger of that party into another entity. Except to the extent forbidden in the previous sentence, this License will be binding upon and inure to the benefit of the respective successors and assigns of the parties.
+
+14.	Choice of Law & Jurisdiction. This License will be governed solely by the internal laws of the State of Florida, without reference to such State’s principles of conflicts of law. The parties consent to the personal and exclusive jurisdiction of the federal and state courts in or for Brevard County, Florida.
+
+## Enterprise License
+
+The enterprise license is forthcoming.
diff --git a/docs/about/open-source.md b/docs/about/open-source.md
new file mode 100644
index 00000000..701f49e5
--- /dev/null
+++ b/docs/about/open-source.md
@@ -0,0 +1,73 @@
+# Binary Ninja
+
+## Open Source
+
+Vector 35 is grateful for the following open source packages that are used in Binary Ninja directly or indirectly:
+
+* Documentation
+
+The following tools are used in the generation of our documentation, but are not distributed themselves and are merely listed here in acknowledgement for the value they provide.
+
+    - [mkdocs] ([mkdocs license] - BSD)
+    - [mkdocs-material] ([mkdocs-material License] - BSD)
+    - [breathe] ([breathe license] - BSD)
+    - [sphinx] ([sphinx license] - BSD and others)
+    - [doxygen] ([doxygen license] - GPLv2)
+
+* UI
+    - [qt] ([qt license] - LGPLv3 / note, please see our [qt build instructions below](open-source.md#building-qt))
+    - [sourcecodepro] ([sourcecodepro license] - SIL open font license)
+    - [opensans] ([opensans license] - Apache 2.0)
+
+* Core
+    - [lzf] ([lzf license] - BSD)
+    - [zlib] ([zlib license] - zlib license)
+    - [openssl] ([openssl license] - openssl license)
+
+* Upvector update Library
+    - [tomcrypt] ([tomcrypt license] - public domain)
+
+
+## Building Qt
+
+Binary Ninja uses [Qt 5.6] under an LGPLv3 license which requires that we host the original sources used to build Qt for our application along with instructions on how that source may be re-built and can replace the version of Qt shipped with Binary Ninja.
+
+Please note that we offer no support for running Binary Ninja with modified Qt libraries.
+
+1. Follow the installation requirements on the [Building Qt 5 from Git] page.
+2. Download the Qt 5.6.0 [tarball] from binary.ninja. (Note this is an unmodified 5.6 identical to that available from Qt's source control, but must be hosted locally according to the [Qt 5.6] terms.
+3. Next, build QT using the aforementioned instructions.
+4. On OS X, you will need to disable the code-signing signature since it would otherwise prevent changes to binaries or shared libraries.  We recommend a tool such as [unsign].
+5. Finally, replace the built libraries:
+     - On OS X, replace the `QtCore.framework`, `QtDBus.framework`, `QtGui.framework`, `QtNetwork.framework`, `QtPrintSupport.framework`, `QtWidgets.framework` folders inside of `/Applications/Binary Ninja.app/Contents/Frameworks`
+     - On Windows, replace the `Qt5core.dll`, `Qt5Gui.dll`, `Qt5Network.dll`, and `Qt5Widgets.dll` files in `C:\Program Files\Vector35\BinaryNinja\`
+     - On Linux, replace the `libQt5Core.so.5`, `libQt5DBus.so.5`, `libQt5Gui.so.5`, `libQt5Network.so.5`, `libQt5Widgets.so.5`, `libQt5XcbQpa.so.5` files wherever Binary Ninja was extracted
+
+[mkdocs]: http://www.mkdocs.org/
+[mkdocs license]: https://github.com/mkdocs/mkdocs/blob/master/LICENSE
+[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
+[mkdocs-material license]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE
+[breathe]: https://github.com/michaeljones/breathe
+[breathe license]: https://github.com/michaeljones/breathe/blob/master/LICENSE
+[sphinx]: http://www.sphinx-doc.org/en/stable/index.html
+[sphinx license]: https://github.com/sphinx-doc/sphinx/blob/master/LICENSE
+[doxygen]: http://www.stack.nl/~dimitri/doxygen/
+[doxygen license]: https://github.com/doxygen/doxygen/blob/master/LICENSE
+[qt]: https://www.qt.io/download/
+[qt license]: https://www.qt.io/qt-licensing-terms/
+[lzf]: http://oldhome.schmorp.de/marc/liblzf.html
+[lzf license]: http://oldhome.schmorp.de/marc/liblzf.html)
+[zlib]: http://www.zlib.net/
+[zlib license]: http://www.zlib.net/zlib_license.html
+[openssl]: https://www.openssl.org/
+[openssl license]: https://www.openssl.org/source/license.html
+[tomcrypt]:  https://github.com/libtom/libtomcrypt
+[tomcrypt license]: https://github.com/libtom/libtomcrypt/blob/develop/LICENSE
+[sourcecodepro]: https://github.com/adobe-fonts/source-code-pro
+[sourcecodepro license]:  https://github.com/adobe-fonts/source-code-pro/blob/master/LICENSE.txt
+[opensans]: https://www.google.com/fonts/specimen/Open+Sans
+[opensans license]: http://www.apache.org/licenses/LICENSE-2.0.html
+[Qt 5.6]: https://www.qt.io/qt-licensing-terms/
+[Building Qt 5 from Git]: https://wiki.qt.io/Building-Qt-5-from-Git
+[tarball]: https://binary.ninja/qt5.6.0.tar.xz
+[unsign]: https://github.com/steakknife/unsign
diff --git a/docs/dev/api.md b/docs/dev/api.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/dev/api.md
diff --git a/docs/dev/plugins.md b/docs/dev/plugins.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/dev/plugins.md
diff --git a/docs/docs.css b/docs/docs.css
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/docs.css
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 00000000..e99e1d31
--- /dev/null
+++ b/docs/favicon.ico
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 00000000..d6673d13
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,56 @@
+# Getting Started
+
+Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja.
+
+## License
+
+When you first run Binary Ninja, it will prompt you for your license key. You should have received your license key via email after your purchase. If not, please contact [support].
+
+![license popup](/images/license-popup.png "License Popup")
+
+Once the license key is installed, you can change it, back it up, or otherwise inspect it simply by looking in:
+
+- OS X: `~/Library/Application Support/Binary Ninja`
+- Linux: `~/.binaryninja`
+- Windows: `%APPDATA%\Binary Ninja`
+
+## Loading Files
+
+You can load files in many ways:
+
+1. Drag-and-drop a file onto the Binary Ninja window
+2. Use the `File/Open` menu or `Open` button on the start screen
+3. Clicking an item in the recent files list
+4. Running Binary Ninja with an optional command-line parameter
+5. Opening a file from a URL via the `⌘-l` or `⌃-l` hotkey
+
+![recent files](/images/recent.png "Recent Files")
+
+## Analysis
+
+As soon as you open a file, Binary Ninja begins its auto-analysis.
+
+Even while Binary Ninja is analyzing a binary, the UI should be responsive. Not only that, but because the analysis prioritizes user-requested analysis, you can start navigating a binary immediately and any functions you select will be added to the top of the analysis queue. The current progress through a binary is shown in the status bar, but note that the total number of items left to analyze will go up as well as the binary is processed and more items are discovered that require analysis.
+
+![auto analysis](/images/analysis.png "Auto Analysis")
+
+Errors or warnings during the load of the binary are also shown in the status bar, along with an icon (in the case of the image above, a large number of warnings were shown). The most common warnings are from incomplete lifting and can be safely ignored. If the warnings include a message like `Data flow for function at 0x41414141 did not terminate`, then please report the binary to the [bug database][issues].
+
+## Interacting
+
+- TBD
+
+## Troubleshooting
+
+- TBD
+
+### Common problems
+
+- TBD
+
+### Getting Support
+
+Vector 35 offers a number of ways to get Binary Ninja [support].
+
+[support]: https://binary.ninja/support.html
+[issues]: https://github.com/Vector35/binaryninja-api/issues
diff --git a/docs/guide/installing.md b/docs/guide/installing.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/guide/installing.md
diff --git a/docs/guide/interface.md b/docs/guide/interface.md
new file mode 100644
index 00000000..460b8df3
--- /dev/null
+++ b/docs/guide/interface.md
@@ -0,0 +1,12 @@
+# Interface
+
+## UI
+
+
+## Views
+
+
+## Options
+
+
+## Hotkeys
diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/guide/plugins.md
diff --git a/docs/guide/running.md b/docs/guide/running.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/guide/running.md
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/guide/troubleshooting.md
diff --git a/docs/guide/type.md b/docs/guide/type.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/guide/type.md
diff --git a/docs/images/analysis.png b/docs/images/analysis.png
new file mode 100644
index 00000000..088d4f32
--- /dev/null
+++ b/docs/images/analysis.png
diff --git a/docs/images/license-popup.png b/docs/images/license-popup.png
new file mode 100644
index 00000000..d61b2b13
--- /dev/null
+++ b/docs/images/license-popup.png
diff --git a/docs/images/logo.png b/docs/images/logo.png
new file mode 100644
index 00000000..c1e1ecb1
--- /dev/null
+++ b/docs/images/logo.png
diff --git a/docs/images/recent.png b/docs/images/recent.png
new file mode 100644
index 00000000..13f3ebe7
--- /dev/null
+++ b/docs/images/recent.png
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..473d7290
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,9 @@
+# Binary Ninja
+
+A new kind of reverse engineering platform
+
+---
+
+[Binary Ninja] is a reverse engineering platform. It focuses on a clean and easy to use interface with a powerful multithreaded analysis built on a custom IL to quickly adapt to a variety of architectures, platforms, and compilers.
+
+[Binary Ninja]: https://binary.ninja/