From 1938c83d01efeec9219bc0f713a48e6da911d46b Mon Sep 17 00:00:00 2001 From: "Marcus D. Hanwell" Date: Sun, 7 Apr 2013 00:41:05 -0400 Subject: [PATCH] Added README.md, CONTRIBUTING.md, install and update Added some standard documentation files, make sure the COPYING file is installed along with the documentation. Change-Id: Iba7ccfb30920feb31fb6e6c6e00e392feb695c38 --- CMakeLists.txt | 7 ++++ CONTRIBUTING.md | 19 +++++++++++ COPYING | 2 +- README | 4 --- README.md | 65 +++++++++++++++++++++++++++++++++++++ cmake/InstallLocation.cmake | 2 +- 6 files changed, 93 insertions(+), 6 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 README create mode 100644 README.md diff --git a/CMakeLists.txt b/CMakeLists.txt index d240cdf54..4ffa0015c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -48,6 +48,13 @@ if(BUILD_DOCUMENTATION) add_subdirectory(docs) endif() +install( + FILES + README.md + CONTRIBUTING.md + COPYING + DESTINATION "${INSTALL_DOC_DIR}/avogadrolibs") + # After all add_subdirectory calls, so the list of plugins is complete: get_property(AvogadroLibs_PLUGINS GLOBAL PROPERTY AvogadroLibs_PLUGINS) get_property(AvogadroLibs_STATIC_PLUGINS GLOBAL diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..714132661 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +Contributing +------------ + +Our project uses Gerrit for code review, and CDash@Home to test proposed +patches before they are merged. Please check our [development][Development] +guide for more details on developing and contributing to the project. The +[project pages][Projects] provide bug, feature and support trackers, along +with many other features such as source browsing. + +Our [wiki][Wiki] is used to document features, flesh out designs and host other +documentation. Our API is [documented using Doxygen][Doxygen] with updated +documentation generated nightly. We have several [mailing lists][MailingLists] +to coordinate development and to provide support. + + [Development]: http://wiki.openchemistry.org/Development "Development guide" + [Projects]: http://projects.openchemistry.org/ "Project trackers" + [Wiki]: http://wiki.openchemistry.org/ "Open Chemistry wiki" + [Doxygen]: http://doc.openchemistry.org/avogadrolibs/api/ "API documentation" + [MailingLists]: http://openchemistry.org/OpenChemistry/help/mailing.html diff --git a/COPYING b/COPYING index 6d0d525d1..d7e554aea 100644 --- a/COPYING +++ b/COPYING @@ -1,4 +1,4 @@ -Copyright (c) 2011-2012, Kitware, Inc. +Copyright (c) 2011-2013, Kitware, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README b/README deleted file mode 100644 index 92a2d34da..000000000 --- a/README +++ /dev/null @@ -1,4 +0,0 @@ -The Avogadro 2 Library - -This repository is in an early state of development, developing what will be -the 2.0 version of the Avogadro library. diff --git a/README.md b/README.md new file mode 100644 index 000000000..6e7c707a5 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +Avogadro 2 +========== +![Avogadro 2][Avogadro2Logo] + +Introduction +------------ + +Avogadro is an advanced molecular editor designed for cross-platform use in +computational chemistry, molecular modeling, bioinformatics, materials science, +and related areas. It offers flexible rendering and a powerful plugin +architecture. The code in this repository is a rewrite of Avogadro with source +code split across a libraries repository and an application repository. Core +features and goals of the Avogadro project: + +* Open source distributed under the liberal 3-clause BSD license +* Cross platform with nightly builds on Linux, Mac OS X and Windows +* Intuitive interface designed to be useful to whole community +* Fast and efficient embracing the latest technologies +* Extensible, making extensive use of a plugin architecture +* Flexible supporting a range of chemical data formats and packages + +![Open Chemistry project][OpenChemistryLogo] +![Kitware, Inc.][KitwareLogo] + +Avogadro 2 is being developed as part of the [Open Chemistry][OpenChemistry] +project at [Kitware][Kitware], along with companion tools and libraries to +support the work. The Avogadro 1.x series currently has more features, and can +be found [here][Avogadro1]. We will be porting more features to the Avogadro 2 +code base, and making regular releases to get feedback from the community. + +Installing +---------- + +We provide nightly binaries built by our [dashboards][Dashboard] for Mac OS +X and Windows. If you would like to build from source we recommend that you +follow our [building Open Chemistry][Build] guide that will take care of +building most dependencies. + +Contributing +------------ + +Our project uses Gerrit for code review, and CDash@Home to test proposed +patches before they are merged. Please check our [development][Development] +guide for more details on developing and contributing to the project. The +[project pages][Projects] provide bug, feature and support trackers, along +with many other features such as source browsing. + +Our [wiki][Wiki] is used to document features, flesh out designs and host other +documentation. Our API is [documented using Doxygen][Doxygen] with updated +documentation generated nightly. We have several [mailing lists][MailingLists] +to coordinate development and to provide support. + + [Avogadro2Logo]: http://openchemistry.org/files/logos/avogadro2.png "Avogadro2" + [OpenChemistry]: http://openchemistry.org/ "Open Chemistry Project" + [OpenChemistryLogo]: http://openchemistry.org/opensourcelogos/openchem100.png "Open Chemistry" + [Kitware]: http://kitware.com/ "Kitware, Inc." + [KitwareLogo]: http://www.kitware.com/img/small_logo_over.png "Kitware" + [Avogadro1]: http://avogadro.openmolecules.net/ "Avogadro 1" + [Dashboard]: http://cdash.openchemistry.org/index.php?project=AvogadroLibs "Avogadro Dashboard" + [Build]: http://wiki.openchemistry.org/Build "Building Avogadro" + [Development]: http://wiki.openchemistry.org/Development "Development guide" + [Projects]: http://projects.openchemistry.org/ "Project trackers" + [Wiki]: http://wiki.openchemistry.org/ "Open Chemistry wiki" + [Doxygen]: http://doc.openchemistry.org/avogadrolibs/api/ "API documentation" + [MailingLists]: http://openchemistry.org/OpenChemistry/help/mailing.html diff --git a/cmake/InstallLocation.cmake b/cmake/InstallLocation.cmake index 40bb9af38..a49edc645 100644 --- a/cmake/InstallLocation.cmake +++ b/cmake/InstallLocation.cmake @@ -20,7 +20,7 @@ if(NOT INSTALL_DATA_DIR) set(INSTALL_DATA_DIR "share") endif() if(NOT INSTALL_DOC_DIR) - set(INSTALL_DOC_DIR "doc") + set(INSTALL_DOC_DIR "${INSTALL_DATA_DIR}/doc") endif() # Set up RPATH for the project too.