Skip to content

Commit

Permalink
Merge pull request #280 from SAP/rimasirich-patch-1
Browse files Browse the repository at this point in the history
Brandvoice review for readme.md
  • Loading branch information
rimasirich authored May 14, 2020
2 parents c936efd + 165c577 commit 321cb7c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@
![](screenshot.png)

## Description
Provide rich user experience for Yeoman generators using VSCode extension or the browser.
With the Application Wizard extension, you can benefit from a rich user experience for yeoman generators. This extension allows developers to reuse existing yeoman generators and provide wizard-like experience with no development efforts.
The repository contains three main packages:
* **Frontend** - The Application Wizard as a standalone vue.js application.
* **Backend** - The backend part which communicate with Yeoman and the system. Runs as a VSCode extension or node.js application.
* **Backend** - The backend part which communicates with Yeoman and the system. Runs as a VSCode extension or node.js application.
* **Yeoman example generator** - Example generator to show usages and test the platform.

## Requirements
* [node.js](https://www.npmjs.com/package/node) version 10 or higher.
* [VSCode](https://code.visualstudio.com/) 1.39.2 or higher or [Theia](https://www.theia-ide.org/) 0.12 or higher.

## Download and Installation
To test run the framework you only need to build & install the backend package, which will automatically build & run the UI.
To test run the framework you only need to build and install the backend package, which will automatically build and run the UI.
### installation
* Clone this repository
* cd into the backend folder
Expand Down Expand Up @@ -49,16 +49,16 @@ To run it do the following:
* On the debug panel choose "Run Extension", and click on the "Run" button.

#### Advanced scenarios
To develop and contribute you can build & install each package seperatly. Instruction on each package in the dedicated readme.md file.
To develop and contribute you can build and install each package separately. Instruction on each package in the dedicated readme.md file.
* [Build & install the client](frontend/README.md)
* [Build & install the backend](backend/README.md)
* [Build & install the yeoman example generator](generator-foodq/README.md)

## How to obtain support
To get more help, support and information please open a github [issue](https://github.com/SAP/yeoman-ui/issues).
To get more help, support, and information please open a github [issue](https://github.com/SAP/yeoman-ui/issues).

## Contributing
Contributing information can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## License
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the [LICENSE]() file.
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the [LICENSE](LICENSE) file.
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "yeoman-ui",
"version": "1.0.7",
"version": "1.0.8",
"displayName": "Application Wizard",
"publisher": "SAPOS",
"author": {
Expand Down

0 comments on commit 321cb7c

Please sign in to comment.