Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sayantancs committed Aug 10, 2017
1 parent 6328e77 commit 7d81d43
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@

# generator-azure-node
# generator-azuresfguest
> Yeoman generator for Azure Service Fabric guest executable projects
## Installation

First, install [Yeoman](http://yeoman.io) and generator-azuresfguest using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
First, install [Yeoman](http://yeoman.io) and generator-azuresfguest using [npm](https://www.npmjs.com/) (we assume you have pre-installed [npm](https://www.npmjs.com/) and [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-azuresfguest
```
The commands might ask for root access. Please run them with ```sudo```, if needed.

Then generate your new project:

```bash
yo azuresfguest
```

You can have a look at our [documentation](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-deploy-existing-app#use-yoeman-to-package-and-deploy-an-existing-executable-on-linux) to understand how can you deploy the generated Service Fabric guest executable application


## Getting To Know Yeoman

* Yeoman has a heart of gold.
Expand All @@ -43,3 +46,15 @@ provided by the bot. You will only need to do this once across all repos using o
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Steps to contribute

Once you have figured out all the legalities above, you can follow the steps below -

* Create a fork of this [repository](https://github.com/Azure/generator-azuresfguest)
* Git clone the forked repository to your development box
* Make the changes
* You can update your local Yeo using ```npm link``` (or ```sudo npm link``` as required) at the project root-level
* Create a new project with ```yo azuresfguest``` (ensure it picks Yeo node-module bits from your local changes)
* Validate that changes are working as expected and not breaking anything regressively - following the steps mentioned in the [documentation](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-deploy-existing-app#use-yoeman-to-package-and-deploy-an-existing-executable-on-linux) by creating and deploying the generated project on a Service Fabric cluster
* Raise a pull request and share with us

0 comments on commit 7d81d43

Please sign in to comment.