From a649a25ad8a2357e49d06485e28143e834e5f395 Mon Sep 17 00:00:00 2001 From: Tyler Jewell Date: Wed, 20 May 2015 11:47:49 -0700 Subject: [PATCH] Updated the readme with pointers to eclipseche.org --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4d37d0bdbcf..aef02e19dc5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Eclipse Che is a cloud IDE and a platform for creating cloud IDE extensions. Che ships with 55 extensions for Java, JavaScript, AngularJS, git, and Docker. Package your own Che extensions to create beautiful, cross-browser developer tooling. +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. Che contains: * A cloud IDE @@ -10,43 +10,44 @@ Che contains: * An Eclipse plug-in for editing, building and running Che projects from within Eclipse -![Eclipse Che](http://docs.codenvy-stg.com/wp-content/uploads/eclipse-che.png "Eclipse Che") +![Eclipse Che](https://codenvy.com/images/image-editor@1x.png "Eclipse Che") 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 operating system that supports Java 1.7 - 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. +Che can be installed on any OS that supports Java 1.7 - 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. ### License Che is open sourced under the Eclipse Public License 1.0. -### Clone the Repository & Checkout Latest Stable Branch +### Clone the repository ```sh git clone https://github.com/codenvy/che.git ``` +If master is unstable, checkout the latest released version. -### Build and Run Che +### Build and run Che ```sh cd che mvn clean install ./che.sh [ start | stop ] ``` -This builds and starts the SDK, which includes an assembly of Java and a bare minimum of extensions building plug-ins (everything required to work with Java apps and Codenvy extensions). +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. Che will be available at ```localhost:8080``` -### Che Sub-Projects: +### Che sub-projects: * **che-plugins**: [A set of plugins for Eclipse Che] (http://github.com/codenvy/che-plugins) * **che-core**: [Core components of Eclipse Che] (http://github.com/codenvy/che-core) * **che-depmgt**: [Maven Dependency Management POM for Che projects] (http://github.com/codenvy/che-depmgt) * **che-parent**: [Maven parent POM for Che projects] (http://github.com/codenvy/che-parent) -### Projects That Are Part of Che +### Other projects that are part of Eclispe Che * **CLI**: [CLI for accessing APIs] (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 +### AngularJS plugin configuration This plugin requires npm, Yeoman, Bower and Grunt to be installed. * npm setup guide : https://github.com/npm/npm @@ -55,7 +56,7 @@ npm is bundled with nodejs which can be downloaded from: http://nodejs.org/downl * 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 +### 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. @@ -64,21 +65,19 @@ npm is bundled with nodejs which can be downloaded from: http://nodejs.org/downl 4. Restart Che. -### Helping Eclipse 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, contribute, and post on the Eclipse Che forums at [https://www.eclipse.org/forums/index.php/t/787421/] (https://www.eclipse.org/forums/index.php/t/787421/). +**Report Bugs:** You can report bugs and contribute [che-dev@eclipse.org](email:che-dev@eclipse.org). ### Documentation & Tutorials -* **Che Binaries:** [http://docs.codenvy.com/download] (http://docs.codenvy.com/download/) -* **Che Getting Started:** [http://eclipse.org/che/] (http://eclipse.org/che/) -* **Che JavaDoc:** [docs.codenvy.com/che/javadoc/] (http://docs.codenvy.com/che/javadoc/) -* **Che Extension Tutorials:** [http://docs.codenvy.com/che/creating-extensions/#creating-che-apps] (http://docs.codenvy.com/che/creating-extensions/#creating-che-apps) +* **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/) ### Contact Information -* **Che Mail List:** [che-dev@eclipse.org](email:che-dev@eclipse.org) -* **Che Forums:** [https://www.eclipse.org/forums/index.php/t/787421/](https://www.eclipse.org/forums/index.php/t/787421/) -* **Website:** [eclipse.org/che](https://eclipse.org/che) -* **Che Project Management Page:** [https://projects.eclipse.org/projects/technology.che](https://projects.eclipse.org/projects/technology.che) +* **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)