Commit 22a3ef1f authored by Jason Rhinelander's avatar Jason Rhinelander
Browse files

Added build instructions; minor build changes

README now contains quick build instructions.

Build now includes only the headers copied into build/include; the
source dir is no longer included in the include list.

Renamed cmake variable eris_include to eris_doc_include to better
describe its purpose (and because I thought it wasn't being used,
forgetting about the doc cmake).
parent e265088f
......@@ -32,10 +32,6 @@ set(LIBERIS_CURRENT "0")
set(LIBERIS_REVISION "0")
set(LIBERIS_AGE "0")
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON)
#set(CMAKE_VERBOSE_MAKEFILE ON)
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules)
# No in-source building
......@@ -50,10 +46,10 @@ foreach(h ${eris_src_include})
if(h MATCHES "\\.in$")
string(REGEX REPLACE "\\.in$" "" h_processed "${h}")
configure_file("${h}" "${h_processed}" @ONLY)
list(APPEND eris_include "${CMAKE_CURRENT_BINARY_DIR}/${h_processed}")
list(APPEND eris_doc_include "${CMAKE_CURRENT_BINARY_DIR}/${h_processed}")
else()
configure_file("${h}" "${h}" COPYONLY)
list(APPEND eris_include "${CMAKE_CURRENT_BINARY_DIR}/${h}")
list(APPEND eris_doc_include "${CMAKE_CURRENT_BINARY_DIR}/${h}")
endif()
endforeach()
......
......@@ -19,6 +19,32 @@ implementations.
The library name, Eris, is the name of the Greek goddess of chaos.
## Compiling
To compile on a unix-like system, create a new build directory somewhere, then
from this directory run:
cmake /path/to/eris
make -j4
You can install directly to the system (usually under /usr/local) using:
make install
or alternatively build a .deb package to install using one of:
make package
followed by an appropriate package command to install the resulting package
(for example, on Debian/Ubuntu: dpkg -i eris_x.y.z~gityyyymmdd~tag_amd64.deb).
You may also be able to use:
cpack -G RPM
to generate a .rpm package instead of a .deb, but this functionality is
untested by the author.
## License
This program is free software: you can redistribute it and/or modify
......
......@@ -25,7 +25,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml.in ${CMAKE_CURRENT_
# that 'make api_doc' only runs doxygen when something in src or include has changed.
add_custom_command(OUTPUT "api/index.html"
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
DEPENDS "Doxyfile.in" "DoxygenLayout.xml.in" ${eris_include}
DEPENDS "Doxyfile.in" "DoxygenLayout.xml.in" ${eris_doc_include}
${CMAKE_SOURCE_DIR}/README.md ${CMAKE_SOURCE_DIR}/CODING-GUIDELINES.md
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/DoxygenLayout.xml
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment