• What is it, what does it do / Abstract
• Project status: working/prototype
• Nuxeo Support

See real examples:

• https://github.com/nuxeo/nuxeo/blob/master/README.md
• https://github.com/nuxeo/nuxeo-drive/blob/master/README.md
• https://github.com/nuxeo/nuxeo-sdk-ios/blob/master/README.md

Use for instance https://github.com/ekalinin/github-markdown-toc:

• Title / Repository Name
  • About / Synopsis
  • Table of contents
  • Installation
  • Usage
    • Screenshots
    • Features
  • Code
    • Content
    • Requirements
    • Limitations
    • Build
    • Deploy (how to install build product)
  • Resources (Documentation and other links)
  • Contributing / Reporting issues
  • License
  • About Nuxeo

Sample:

• From the Nuxeo Marketplace: install the Sample Nuxeo Package.
• From the command line: nuxeoctl mp-install nuxeo-sample

Description, sub-modules organization...

See CORG/Compiling Nuxeo from sources

Sample: https://github.com/nuxeo/nuxeo/blob/master/nuxeo-distribution/README.md

Sample: https://github.com/nuxeo-archives/nuxeo-features/tree/master/nuxeo-elasticsearch

mvn clean install

Build options:

• ...

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.

Link to JIRA component (or project if there is no component for that project). Samples:

• Link to component
• Link to project

Apache License, Version 2.0

Nuxeo Platform is an open source Content Services platform, written in Java. Data can be stored in both SQL & NoSQL databases.

The development of the Nuxeo 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, case management, and 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.