Skip to content

Commit

Permalink
[getting-started] update extension readme
Browse files Browse the repository at this point in the history
Updates the `getting-started` extension readme following the new template.
The new template consists of:
- extension header
- extension description
- extension docs: generated API documentation
- extension license
- extension trademark

Signed-off-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
  • Loading branch information
vince-fugnitto authored and marcdumais-work committed Feb 27, 2020
1 parent 22ad835 commit 03c0ad2
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 3 deletions.
37 changes: 37 additions & 0 deletions logo/theia.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 28 additions & 3 deletions packages/getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,40 @@
# Theia - Getting Started Extension
<div align='center'>

<br />

<img src='../../logo/theia.svg' width='100px' />

<h2>THEIA - GETTING-STARTED EXTENSION</h2>

<hr />

</div>


## Description

The extension contributes a `getting-started` widget which is displayed when opening the application
without a workspace present. The `getting-started` widget provides useful commands and functionality for quickly getting up to speed with the application:
The `@theia/getting-started` extension contributes a default `getting-started` widget which is displayed whenever
opening the application without any workspace present or if the widget is explicitly opened (through the menu or command).

The `getting-started` widget provides useful commands and functionality for quickly getting up to speed with the application. For example:
- `open commands`: commands which are used to open files, folders, and workspaces quickly.
- `recent workspaces`: recently used workspaces are listed for easy and quick access.
- `settings commands`: commands which are used to open the preferences and keyboard shortcuts widgets.
- `help`: useful links pointing to documentation and/or guides.


## Additional Information

- [API documentation for `@theia/getting-started`](https://eclipse-theia.github.io/theia/docs/next/modules/getting_started.html)
- [Theia - GitHub](https://github.com/eclipse-theia/theia)
- [Theia - Website](https://theia-ide.org/)

## License

- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)


## Trademark
"Theia" is a trademark of the Eclipse Foundation
https://www.eclipse.org/theia

0 comments on commit 03c0ad2

Please sign in to comment.