Add license and documentation.

Author: lhames

orc-rt/CMakeLists.txt

@@ -18,6 +18,11 @@ include(GNUInstallDirs)
 # Setup CMake Options
 #===============================================================================
 
+option(ORC_RT_INCLUDE_DOCS "Build the ORC-RT documentation." ${ORC_RT_INCLUDE_DOCS})
+option(ORC_RT_ENABLE_ASSERTIONS "Enable assertions independent of build mode." ON)
+option(ORC_RT_ENABLE_PEDANTIC "Compile with pedantic enabled." ON)
+option(ORC_RT_ENABLE_WERROR "Fail and stop if a warning is triggered." OFF)
+
 set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ standard to conform to")
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
 set(CMAKE_CXX_EXTENSIONS NO)
@@ -27,6 +32,10 @@ set(CMAKE_FOLDER "orc-rt")
 # Setup Source Code
 #===============================================================================
 
+if (ORC_RT_INCLUDE_DOCS)
+  add_subdirectory(docs)
+endif()
+
 add_subdirectory(include)
 add_subdirectory(lib)
 add_subdirectory(tools)

orc-rt/CREDITS.TXT

@@ -0,0 +1,13 @@
+This file is a partial list of people who have contributed to the LLVM
+project. If you have contributed a patch or made some other contribution to
+LLVM, please submit a patch to this file to add yourself, and it will be
+done!
+
+The list is sorted by surname and formatted to allow easy grepping and
+beautification by scripts.  The fields are: name (N), email (E), web-address
+(W), PGP key ID and fingerprint (P), description (D), snail-mail address
+(S), and (I) IRC handle.
+
+N: Lang Hames
+E: [email protected]
+D: Initial code

orc-rt/LICENSE.TXT

@@ -0,0 +1,90 @@
+.. _Building_ORC_RT:
+
+==================
+Building ORC-RT
+==================
+
+.. contents::
+  :local:
+
+.. _build instructions:
+
+Getting Started
+===============
+
+The basic steps needed to build orc-rt are:
+
+#. Checkout llvm-project:
+
+   * ``cd where-you-want-llvm-to-live``
+   * ``git clone https://github.com/llvm/llvm-project.git``
+
+#. Configure and build orc-rt:
+
+   CMake is the only supported configuration system.
+
+   Clang is the preferred compiler when building and using orc-rt.
+
+   * ``cd where you want to build llvm``
+   * ``mkdir build``
+   * ``cd build``
+   * ``cmake -G <generator> -DLLVM_ENABLE_RUNTIMES=orc-rt [options] <llvm-monorepo>/runtimes``
+
+   For more information about configuring orc-rt see :ref:`CMake Options`.
+
+   * ``make orc-rt`` --- will build orc-rt.
+   * ``make check-orc-rt`` --- will run the test suite.
+
+   Shared and static libraries for orc-rt should now be present in
+   llvm/build/lib.
+
+#. **Optional**: Install orc-rt
+
+   Remember Use the CMake option ``CMAKE_INSTALL_PREFIX`` to select a safe
+   place to install orc-rt.
+
+   * ``make install-orc-rt`` --- Will install the libraries and the headers
+
+.. _CMake Options:
+
+CMake Options
+=============
+
+Here are some of the CMake variables that are used often, along with a
+brief explanation and LLVM-specific notes. For full documentation, check the
+CMake docs or execute ``cmake --help-variable VARIABLE_NAME``.
+
+**CMAKE_BUILD_TYPE**:STRING
+  Sets the build type for ``make`` based generators. Possible values are
+  Release, Debug, RelWithDebInfo and MinSizeRel. On systems like Visual Studio
+  the user sets the build type with the IDE settings.
+
+**CMAKE_INSTALL_PREFIX**:PATH
+  Path where LLVM will be installed if "make install" is invoked or the
+  "INSTALL" target is built.
+
+**CMAKE_CXX_COMPILER**:STRING
+  The C++ compiler to use when building and testing orc-rt.
+
+.. _orc-rt-specific options:
+
+orc-rt specific options
+--------------------------
+
+.. option:: ORC_RT_ENABLE_ASSERTIONS:BOOL
+
+  **Default**: ``ON``
+
+  Toggle assertions independent of the build mode.
+
+.. option:: ORC_RT_ENABLE_PEDANTIC:BOOL
+
+  **Default**: ``ON``
+
+  Compile with -Wpedantic.
+
+.. option:: ORC_RT_ENABLE_WERROR:BOOL
+
+  **Default**: ``ON``
+
+  Compile with -Werror

orc-rt/docs/Building-ORC-RT.rst

@@ -0,0 +1,8 @@
+if (LLVM_ENABLE_SPHINX)
+  include(AddSphinxTarget)
+  if (SPHINX_FOUND)
+    if (${SPHINX_OUTPUT_HTML})
+      add_sphinx_target(html orc-rt)
+    endif()
+  endif()
+endif()

orc-rt/docs/CMakeLists.txt

@@ -0,0 +1,13 @@
+ORC-RT Documentation
+====================
+
+The ORC-RT documentation is written using the Sphinx documentation generator. It is
+currently tested with Sphinx 1.1.3.
+
+To build the documents into html configure ORC-RT with the following cmake options:
+
+  * -DLLVM_ENABLE_SPHINX=ON
+  * -DORC_RT_INCLUDE_DOCS=ON
+
+After configuring ORC-RT with these options the make rule `docs-orc-rt-html`
+should be available.