diff --git a/Readme.md b/Readme.md index 092f225..a5b1166 100644 --- a/Readme.md +++ b/Readme.md @@ -1,107 +1,107 @@ # Title / Repository Name ## About / Synopsis * What is it, what does it do / Abstract * Project status: working/prototype * Nuxeo Support See real examples: * * * ## Table of contents Use for instance : > * [Title / Repository Name](#title--repository-name) > * [About / Synopsis](#about--synopsis) > * [Table of contents](#table-of-contents) > * [Installation](#installation) > * [Usage](#usage) > * [Screenshots](#screenshots) > * [Features](#features) > * [Code](#code) > * [Content](#content) > * [Requirements](#requirements) > * [Limitations](#limitations) > * [Build](#build) > * [Deploy (how to install build product)](#deploy-how-to-install-build-product) > * [Resources (Documentation and other links)](#resources-documentation-and-other-links) > * [Contributing / Reporting issues](#contributing--reporting-issues) > * [License](#license) > * [About Nuxeo](#about-nuxeo) ## Installation Sample: * From the Nuxeo Marketplace: install [the Sample Nuxeo Package](https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-sample). * From the command line: `nuxeoctl mp-install nuxeo-sample` ## Usage ### Screenshots ### Features ## Code [![Build Status](https://qa.nuxeo.org/jenkins/buildStatus/icon?job=/nuxeo/addons_nuxeo-sample-project-master)](https://qa.nuxeo.org/jenkins/job/nuxeo/job/addons_nuxeo-sample-project-master/) ### Content Description, sub-modules organization... ### Requirements See [CORG/Compiling Nuxeo from sources](http://doc.nuxeo.com/x/xION) Sample: ### Limitations Sample: ### Build mvn clean install Build options: * ... ### Deploy (how to install build product) Direct to MP package if any. Otherwise provide steps to deploy on Nuxeo Platform: > Copy the built artifacts into `$NUXEO_HOME/templates/custom/bundles/` and activate the `custom` template. ## Resources (Documentation and other links) ## Contributing / Reporting issues Link to JIRA component (or project if there is no component for that project). Samples: * [Link to component](https://jira.nuxeo.com/issues/?jql=project%20%3D%20NXP%20AND%20component%20%3D%20Elasticsearch%20AND%20Status%20!%3D%20%22Resolved%22%20ORDER%20BY%20updated%20DESC%2C%20priority%20DESC%2C%20created%20ASC) * [Link to project](https://jira.nuxeo.com/secure/CreateIssue!default.jspa?project=NXP) ## License [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) ## About Nuxeo Nuxeo Content Platform is an open source Enterprise Content Management platform, written in Java. Data can be stored in both SQL & NoSQL databases. The development of the Nuxeo Content Platform is mostly done by Nuxeo employees with an open development model. The source code, documentation, roadmap, issue tracker, testing, benchmarks are all public. Typically, Nuxeo users build different types of information management solutions for [document management](https://www.nuxeo.com/products/document-management/), [case management](https://www.nuxeo.com/products/case-management/), and [digital asset management](https://www.nuxeo.com/products/digital-asset-management/), use cases. It uses schema-flexible metadata & content models that allows content to be repurposed to fulfill future use cases. More information is available at [www.nuxeo.com](http://www.nuxeo.com). -A₂ +Aᵀ