From 473a9980bee8e963c09b23ac5eea9bc1ddd0f61b Mon Sep 17 00:00:00 2001 From: Tyler Jewell Date: Mon, 17 Aug 2015 17:15:43 -0700 Subject: [PATCH] Updated language to reflect latest. --- README.md | 58 ++++++++++++++----------------------------------------- 1 file changed, 15 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 932b91b1706..7306eb8a640 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ -Eclipse Che is both a cloud IDE and an SDK for creating a custom cloud IDE by packaging extensions you author into an assembly. Che can be used as a desktop IDE, embedded IDE, or a hosted IDE. +High performance, open source software developer environments in the cloud. -Che contains: -* A cloud IDE -* A set of extensions for many programming languages, source code systems, builders and runners -* A kernel for loading extensions authored as plug-ins -* Developer tooling for building and and assembling plug-ins to create new IDEs -* A set of platform APIs for developer microservices (e.g., 'build project' or 'search workspace') -* A CLI for interacting with platform APIs -* An Eclipse plug-in for editing, building and running Che projects from within Eclipse +### Cloud IDE +Use your browser to program on any machine in any language. Edit, build, debug and deploy projects bound to source repositories. [Use Che as an IDE] (https://eclipse-che.readme.io/docs/import-a-project) +### Workspace Server +Create developer environments with APIs. Add your project types, embed custom commands and host on any infrastructure. [Use Che as a Workspace Server] (https://eclipse-che.readme.io/docs/create-workspaces-and-projects) -![Eclipse Che](https://codenvy.com/images/image-editor@1x.png "Eclipse Che") +### Plug-Ins +Use Che's built-in language plug-ins or write packaged extensions that transform Che's IDE into new tools and assemblies. [Write Che IDE Plug-Ins] (https://eclipse-che.readme.io/docs/extension-development-workflow) -The IDE is a browser application that is generated by compiling extensions into JavaScript. Extensions can invoke server-side APIs that run within the Che kernel. The kernel is a servlet-based framework that loads and manages extensions. The kernel can be run in any servlet container with a default bundling of Tomcat. -Che can be installed on any OS that supports Java 1.8 - desktop, server or cloud, and Maven 3.1.1 or higher. It has been tested on Ubuntu, Linux, MacOS and Windows. Java, GWT, GIN and JavaScript are the core technologies used to build Che. + +![Eclipse Che](https://www.eclipse.org/che/img/che-autocomplete.png "Eclipse Che") + +Che can be installed on any OS that supports Java 1.8 - desktop, server or cloud, and Maven 3.1.1 or higher. It has been tested on Ubuntu, Linux, MacOS and Windows. ### License Che is open sourced under the Eclipse Public License 1.0. @@ -33,7 +32,7 @@ mvn clean install ./che.sh [ start | stop ] ``` -This builds and runs an assembly with Java and extensions required for building plug-ins. You can create other assemblies that include your extensions or the complete set provided with Che. +This builds and runs an assembly with the Java plug-in and extension SDK. You can use the SDK to create other assemblies of Che. Che will be available at ```localhost:8080``` @@ -47,37 +46,10 @@ Che will be available at ```localhost:8080``` * **CLI**: [CLI for interacting with Che remotely] (http://github.com/codenvy/cli) * **Eclipse Plug-In**: [An Eclipse plug-in for running Che projects] (http://github.com/codenvy/eclipse-plugin) -### AngularJS plugin configuration -This plugin requires npm, Yeoman, Bower and Grunt to be installed. - -* npm setup guide : https://github.com/npm/npm -npm is bundled with nodejs which can be downloaded from: http://nodejs.org/download/ - -* Yeoman (and bower / Grunt dependencies can be installed with: npm install -g yo) - more details on http://yeoman.io/gettingstarted.html - -### Add your extensions to Che -1. Create, build and compile a Che extension into a Java JAR file. [Tutorial is here] (http://docs.codenvy.com/che/). You can create extension JARs within Che or your favorite IDE. Build extensions in Eclipse gives you super dev mode for Eclipse, which makes incremental compilation fast. - -2. Copy the extension's JAR file to ```/assembly-sdk/target/tomcat-ide/ext``` directory of Che. - -3. Execute ```$ ./extInstall.sh``` script. Che will be re-compiled with your extension. This will take a few minutes. - -4. Restart Che. - ### Help us - -**Contribute:**: We accept pull requests, so if you feel like contributing to the project, you are definitely welcome to do so. - -**Report Bugs:** You can report bugs and contribute [che-dev@eclipse.org](email:che-dev@eclipse.org). - -### Documentation & Tutorials -* **Che Getting Started:** [http://eclipseche.org/] (http://eclipseche.org/) -* **Che Docs:** [http://eclipseche.org/docs] (http://eclipseche.org/docs) -* **Che Extension Authoring:** [http://eclipseche.org/docs/extension-development/] (http://eclipseche.org/docs/extension-development/) - +**Contribute:**: We accept pull requests, so you are welcome to submit many! +**Support:** You can report bugs and contribute [che-dev@eclipse.org](email:che-dev@eclipse.org). ### Contact Information * **Che Mailing List:** [che-dev@eclipse.org](email:che-dev@eclipse.org) -* **Website:** [eclipseche.org](https://eclipseche.org) -* **Eclipse Che Project Page:** [https://projects.eclipse.org/projects/technology.che](https://projects.eclipse.org/projects/technology.che) +* **Website:** [eclipse.org/che](https://eclipse.org/che)