ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-02-06 11:10:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve README.md

Browse Source 
- Make user oriented instead of developer oriented.
- Remove deprecated information.
- Add Requisites section.
- Add Getting Started section.
- Add Support section.
- Add License section.
This commit is contained in:
Juan Cruz Viotti 2015-09-21 07:56:24 -04:00
parent eb4c2f62a7
commit eecd7a0fd8
1 changed files with 33 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -1,4 +1,5 @@
# Resin CLI Resin CLI
=========
[![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli) [![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli)
[![dependencies](https://david-dm.org/resin-io/resin-cli.png)](https://david-dm.org/resin-io/resin-cli.png) [![dependencies](https://david-dm.org/resin-io/resin-cli.png)](https://david-dm.org/resin-io/resin-cli.png)
@ -7,48 +8,54 @@
The official Resin CLI tool. The official Resin CLI tool.
## Installing Requisites
----------
- [NodeJS](https://nodejs.org) (at least v0.10)
- [Git](https://git-scm.com)
Getting Started
---------------
### Installing
This might require elevated privileges in some environments.
```sh ```sh
$ npm install -g resin-cli $ npm install -g resin-cli
``` ```
### Running locally ### Login
```sh ```sh
$ ./bin/resin $ resin login
``` ```
## Tests ### List available commands
You can run the [Mocha](http://mochajs.org/) test suite, you can do:
```sh ```sh
$ gulp test $ resin help
``` ```
## Development mode ### Run the quickstart wizard
The following command will watch for any changes and will run a linter and the whole test suite: Run as `root` on UNIX based systems, and in an administrator command line prompt in Windows.
```sh ```sh
$ gulp watch $ resin quickstart
``` ```
If you set `DEBUG` environment variable, errors will print with a stack trace: Caveats
-------
```sh
$ DEBUG=true resin ...
```
## Documentation
You can renegerate the documentation with:
```sh
$ npm run-script doc
```
## Caveats
- Some interactive widgets don't work on [Cygwin](https://cygwin.com/). If you're running Windows, it's preferrable that you use `cmd.exe`, as `Cygwin` is [not official supported by Node.js](https://github.com/chjj/blessed/issues/56#issuecomment-42671945). - Some interactive widgets don't work on [Cygwin](https://cygwin.com/). If you're running Windows, it's preferrable that you use `cmd.exe`, as `Cygwin` is [not official supported by Node.js](https://github.com/chjj/blessed/issues/56#issuecomment-42671945).
Support
-------
If you're having any problem, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help.
License
-------
The project is licensed under the MIT license.