Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

Commit

Permalink
Align README with Dashboard (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
sleshchenko authored Jan 6, 2021
1 parent 92aeac2 commit 7f0263f
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# About Eclipse Che Dashboard
## About Eclipse Che

This is the first step to implement a new Eclipse Che Dashboard.
Eclipse Che is a next generation Eclipse IDE. This repository is licensed under the Eclipse Public License 2.0. Visit [Eclipse Che's Web site](https://eclipse.org/che/) for feature information or the main [Che assembly repository](https://github.com/eclipse/che) for a description of all participating repositories.

# Eclipse Che Dashboard

## Requirements

- Node.js `v10.x.x` and later.
- yarn `v1.20.0` or higher.

**Note**:
Below you can find installation instructions
- [Node.js](https://docs.npmjs.com/getting-started/installing-node)
- [yarn](https://yarnpkg.com/lang/en/docs/install/)

## Quick start

Expand Down Expand Up @@ -51,6 +59,24 @@ and then run the license-tool:
yarn licenseCheck:run
```

## Branding

Default branding data for the User Dashboard is located in [branding.constant.ts](src/services/bootstrap/branding.constant.ts)#BRANDING_DEFAULT. It can be overridden without re-building the project in [product.json](/assets/branding/product.json) file which should contain only values that should overwrite default ones.

### Configurability

Field `"configuration.cheCliTool"` should contain the name of a CLI tool that is recommended to be used to work with Che Server from the terminal. It's the `"chectl"` by default.

Example:

```json
{
"configuration": {
"cheCliTool": "chectl"
}
}
```

## License

Che is open sourced under the Eclipse Public License 2.0.

0 comments on commit 7f0263f

Please sign in to comment.