mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-05-19 17:15:24 +00:00
Updated README for SDK 2.1.0 release
This commit is contained in:
parent
6ebaa083d4
commit
19b0d1d8a7
55
README.md
55
README.md
@ -1,24 +1,50 @@
|
|||||||
# [](#features) Alfresco SDK
|
# [](#features) Alfresco SDK
|
||||||
|
|
||||||
This is the home of the source code for the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco content management system. It is maven based and enables Rapid Application Development (RAD) and Test Driven Development (TDD).
|
This is the home of the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco content management system. It is based on [Apache Maven](http://maven.apache.org/), compatible with major IDEs and enables Rapid Application Development (RAD) and Test Driven Development (TDD).
|
||||||
|
|
||||||
## Gettin Started
|
## License
|
||||||
|
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
|
||||||
|
|
||||||
To get started visit the offical [Alfresco Documentation](http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html).
|
## News
|
||||||
|
- 2015-05-20: SDK 2.1.0 released to Maven Central. Docs for [Community](http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html), [Enterprise](http://docs.alfresco.com/5.0/concepts/alfresco-sdk-intro.html), [Release notes](https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-sdk-aggregator/latest/github-report.html)
|
||||||
|
- 2014-12-23: SDK 2.0.0 release to Maven Central. [Docs](http://docs.alfresco.com/sdk2.0/concepts/alfresco-sdk-intro.html), [Release Notes](https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-sdk-aggregator/archive/2.0.0/github-report.htm)
|
||||||
|
- 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the [OSS Sonatype Repository](https://oss.sonatype.org/content/repositories/snapshots/org/alfresco/maven/alfresco-sdk-parent/2.0.0-SNAPSHOT/)!
|
||||||
|
- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes).
|
||||||
|
|
||||||
|
## User Getting Started
|
||||||
|
|
||||||
|
To get started with Alfresco SDK 2.1 (latest) visit the offical Alfresco Documentation for:
|
||||||
|
|
||||||
|
- [Alfresco Community](http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html)
|
||||||
|
- [Alfresco Enterprise 5.0.1](http://docs.alfresco.com/5.0/concepts/alfresco-sdk-intro.html)
|
||||||
|
|
||||||
|
### Previous versions
|
||||||
|
- Documentation for [Alfresco SDK 2.0](http://docs.alfresco.com/sdk2.0/concepts/alfresco-sdk-intro.html)
|
||||||
|
|
||||||
### Samples
|
### Samples
|
||||||
|
Sample extension projects that use the SDK, maintained by @ohej in the [Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/).
|
||||||
|
|
||||||
Sample extension projects that uses the SDK, maintained by @ohej in the [Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/).
|
### Want to get up to speed quickly in Eclipse? Check out this video!
|
||||||
|
|
||||||
### Want to get up to speed quickly, check out this video
|
|
||||||
|
|
||||||
For an overview of the SDK potential check out this video:
|
|
||||||
[TODO]
|
|
||||||
[](https://www.youtube.com/watch?v=utYZaVe9Nd0)
|
[](https://www.youtube.com/watch?v=utYZaVe9Nd0)
|
||||||
|
|
||||||
## Reporting Issues and getting Support
|
## Reporting Issues and getting Support
|
||||||
|
|
||||||
Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/issues?milestone=1&state=open). You can also join the [Alfresco list on Google Groups](https://groups.google.com/forum/#!forum/maven-alfresco).
|
Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/issues?milestone=1&state=open). You can also join the [Alfresco list on Google Groups](https://groups.google.com/forum/#!forum/maven-alfresco) or join us on the [IRC Channel](http://chat.alfresco.com/).
|
||||||
|
|
||||||
|
## Alfresco Enterprise Customers and Partners
|
||||||
|
|
||||||
|
### Support
|
||||||
|
If you are an Alfresco Customer please check the [SDK Support status](http://www.alfresco.com/services/subscription/technical-support/product-support-status) for the version you are using and the (Compabitily Matrix)[http://docs.alfresco.com/community/concepts/alfresco-sdk-compatibility.html] for the SDK / Alfresco compatibility. If your version is in Limited or Full Support, you can raise issues via the Support Portal.
|
||||||
|
|
||||||
|
### Maven repositories
|
||||||
|
The Alfresco SDK is released in Maven Central as of version 2.0-beta-1. Previous versions are available in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
||||||
|
|
||||||
|
Alfresco (Community and Enterprise) artifacts are hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
||||||
|
|
||||||
|
Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available.
|
||||||
|
|
||||||
|
For Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See [docs for Enterprise](http://docs.alfresco.com/5.0/concepts/alfresco-sdk-tutorials-alfresco-enterprise.html).
|
||||||
|
|
||||||
## For Developers that want to contribute to the SDK
|
## For Developers that want to contribute to the SDK
|
||||||
|
|
||||||
@ -49,15 +75,6 @@ alfresco-sdk$ mvn clean install -Dmaven.test.skip=true
|
|||||||
$ mvn archetype:generate -DarchetypeCatalog=local
|
$ mvn archetype:generate -DarchetypeCatalog=local
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
This project is released under the Apache License, Version 2.0. It's a community driven project which is supported for Alfresco Development (please refere to the official Alfresco Documentation for supported features.
|
||||||
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
|
|
||||||
|
|
||||||
## News
|
|
||||||
- 2015-05-08: SDK 2.1.0-beta-1 released to Maven Central
|
|
||||||
- 2014-12-20: SDK 2.0.0 in staging. If you want early access to the release candidate build and want to participate to the testing process check [this page](https://github.com/Alfresco/alfresco-sdk/wiki/SDK-Supported-Features-and-Test-plan) and report issues [here](https://github.com/Alfresco/alfresco-sdk/issues).
|
|
||||||
- 2014-09-10: SDK 2.0.0-beta-4 released to Maven Central and in the [Archetype Catalog](http://repo1.maven.org/maven2/archetype-catalog.xml)!
|
|
||||||
- 2014-09-09: SDK 2.0.0-beta-3 released to Maven Central
|
|
||||||
- 2014-08-30: SDK 2.0.0-beta-1 and 2.0.0-beta-2 available in [Maven Central](http://search.maven.org/#search|ga|1|org.alfresco.maven)
|
|
||||||
- 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the [OSS Sonatype Repository](https://oss.sonatype.org/content/repositories/snapshots/org/alfresco/maven/alfresco-sdk-parent/2.0.0-SNAPSHOT/)!
|
|
||||||
- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes), including tags, branches, issues. Allow a little time for a full cleanup of issue labels and to sort repository permissions. Please update obsolete references and bear with us as we update Alfresco Documentation to this change.
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user