8000 Initial readme by JonasSchaub · Pull Request #8 · cdk/cdk-scaffold · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Initial readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 10, 2023
Merged

Initial readme #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
786e5d5
Initial readme
JonasSchaub May 10, 2023
e96a705
Removed acknowledgement and installation of cdk-bundle
JonasSchaub May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.openscience.cdk/cdk-scaffold/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.openscience.cdk/cdk-scaffold) [![build](https://github.com/cdk/cdk-scaffold/actions/workflows/maven.yml/badge.svg)](https://github.com/cdk/cdk-scaffold/actions/workflows/maven.yml) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=cdk-scaffold&metric=bugs)](https://sonarcloud.io/summary/new_code?id=cdk-scaffold)

# CDK-Scaffold Module
## Scaffold Functionalities for the Chemistry Development Kit (CDK)

Copyright © 2023 The CDK Development Team, especially
[Julian Zander](mailto:zanderjulian@gmx.de),
[Jonas Schaub](mailto:jonas.schaub@uni-jena.de),
[Achim Zielesny](mailto:achim.zielesny@w-hs.de),
[Christoph Steinbeck](mailto:christoph.steinbeck@uni-jena.de)

License: LGPL v2, see LICENSE.txt

[Home Page](https://cdk.github.io/) | [JavaDoc](http://cdk.github.io/cdk-scaffold/latest/docs/api/index.html?overview-summary.html) | [Wiki](https://github.com/cdk/cdk-scaffold/wiki) | [Issues](https://github.com/cdk/cdk-scaffold/issues) | [Mailing List](https://sourceforge.net/projects/cdk/lists/cdk-user)

## Introduction

The CDK is an open-source Java library for cheminformatics and bioinformatics. For more details, visit the main CDK repository
at [https://github.com/cdk/cdk](https://github.com/cdk/cdk).

The cdk-scaffold module makes versatile molecular scaffold functionalities available for integration with CDK-based workflows
and software. All details of the functionality and implementation are described in <a href="https://doi.org/10.1186/s13321-022-00656-x">
Schaub et al. "Scaffold Generator: a Java library implementing molecular scaffold functionalities in the Chemistry Development Kit (CDK)" (J Cheminform 14, 79, 2022)</a><p>

## Install

The library is built with Apache Maven and currently requires Java 1.8 or later.

You can download a pre-built library JAR from [releases](https://github.com/cdk/cdk-scaffold/releases).

If you are using Maven, you can install the cdk-bundle package using:

```xml
<dependency>
<artifactId>cdk-scaffold</artifactId>
<groupId>org.openscience.cdk</groupId>
<version>2.8</version>
</dependency>
```

Further details on building the project in integrated development environments (IDEs) are available on the wiki:
* [Building the CDK](https://github.com/cdk/cdk/wiki/Building-CDK)
* [Maven Reporting Plugins](https://github.com/cdk/cdk/wiki/Maven-Reporting-Plugins)

## Getting Help

The [Toolkit-Rosetta Wiki Page](https://github.com/cdk/cdk/wiki/Toolkit-Rosetta) provides some examples for common tasks. If you need help using the CDK and have questions please use the user mailing list, [``cdk-user@lists.sf.net``](mailto:cdk-user@lists.sf.net) (**you must [subscribe here]( https://sourceforge.net/projects/cdk/lists/cdk-user) first to post**).
0