Skip to content

Typos and grammar edits in Readme.md #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timotheeguerin merged 3 commits into from
Jun 20, 2017
Merged

Typos and grammar edits in Readme.md #477

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
667d5c7
Typos and grammar edits in Readme.md
davefellows Jun 19, 2017
a10c14a
Merge branch 'master' into davefellows-patch-1
timotheeguerin Jun 19, 2017
d3ac629
Merge branch 'master' into davefellows-patch-1
timotheeguerin Jun 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

**Note: BatchLabs is in beta. We don't provide any installer/packaged binaries as of now. You will need to build this app yourself.**

This is the readme for master branch is contains the latest changes. Stable might be slightly different [Stable readme](https://github.com/Azure/BatchLabs/tree/stable)
This is the readme for the 'master' branch which contains the latest changes, 'stable' may differ from this [Stable readme](https://github.com/Azure/BatchLabs/tree/stable)

## Description

Batch Labs is a tool to manage your Azure Batch accounts. The goal is to implement some great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
It will also include expermiental features such as `No Code Job` in the aim to improve your Batch experience. We are open to any feedback, ideas and contribution you might have.
Batch Labs is a tool to manage your Azure Batch accounts. The goal is to implement a great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
It will also include expermiental features such as `Batch Templates` in the aim to improve your Batch experience. We are open to any feedback, ideas and contributions you might have.

## Getting started
#### 1. Prerequisites
Expand All @@ -24,7 +24,7 @@ Move to the directory `cd BatchLabs`
```bash
yarn install
```
Note: You can also use `npm install` at your own risk. However please do not submit an issue if you didn't use `yarn install`. Yarn will make sure you have the exact same set of dependencies as everybody which remove any unexpected third party bugs problems.
Note: You can also use `npm install` at your own risk. However please do not submit an issue if you didn't use `yarn install`. Yarn will make sure you have the right set of dependencies, which reduces the likelihood of any unexpected build issues relating to third party packages.

#### 4. Build and run the application
```bash
Expand All @@ -44,7 +44,7 @@ npm run electron
[Dev docs](docs/readme.md)

For developers, you can set up a development environment as follows:
**Use `yarn install` instead of `npm install` this will makes sure everybody has the same exact set of depenencies [Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**
**Use `yarn install` instead of `npm install`. This ensures a consistent build environment with the right set of dependencies [Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**

Start the dev server
```bash
Expand Down Expand Up @@ -79,7 +79,7 @@ Please also take a look at the [coding guidelines](coding-guidelines.md) for thi
In vscode install the editorconfig extension

## Detailed commands:
**Magic command(Starts the server and electron in dev mode)**
**Magic command (starts the server and electron in dev mode)**
```
npm run dev
```
Expand All @@ -94,17 +94,17 @@ Run app
npm run electron
```

Run watch(This will build files on save)
Run watch (this will build files on save)
```
npm run watch
```

Run dev server(This will handle the refresh of files and later should have live reloead)
Run dev server (this will handle the refresh of files and later should have live reload)
```
npm run dev-server
```

Run dev electron(To use the dev server you need to run this)
Run dev electron (to use the dev server you need to run this)
```
npm run dev-electron
```
Expand Down