Skip to content

Commit

Permalink
Added README.md, CONTRIBUTING.md, install and update
Browse files Browse the repository at this point in the history
Added some standard documentation files, make sure the COPYING file is
installed along with the documentation.

Change-Id: Iba7ccfb30920feb31fb6e6c6e00e392feb695c38
  • Loading branch information
cryos committed Apr 7, 2013
1 parent 06b9bb9 commit 1938c83
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CMakeLists.txt
Expand Up @@ -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
Expand Down
19 changes: 19 additions & 0 deletions 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
2 changes: 1 addition & 1 deletion 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
Expand Down
4 changes: 0 additions & 4 deletions README

This file was deleted.

65 changes: 65 additions & 0 deletions 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
2 changes: 1 addition & 1 deletion cmake/InstallLocation.cmake
Expand Up @@ -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.
Expand Down

0 comments on commit 1938c83

Please sign in to comment.