| 1 | <div align="center">
|
| 2 | <img src="https://github.com/Stratio/egeo-web/blob/master/src/assets/images/egeo_logo_c.png">
|
| 3 | </div>
|
| 4 |
|
| 5 | # Egeo-Cli (Beta)
|
| 6 |
|
| 7 | EGEO-CLI is the open-source util used to automatize document task that we do when develop for stratio and egeo. The goals are to reduce the time and complexity of document for being more productive.
|
| 8 |
|
| 9 | In this repository, you'll find a initial version of this cli. You can discover more in:
|
| 10 |
|
| 11 | * [egeo](https://github.com/Stratio/egeo): The egeo library of components.
|
| 12 | * [egeo-web](https://github.com/Stratio/egeo-web): The official website of Egeo where documentation will be available soon.
|
| 13 | * [egeo-ui-base](https://github.com/Stratio/egeo-ui-base): A Sass library that helps us to build our styles, including a rewritten Sass version of [flexboxgrid](http://flexboxgrid.com/).
|
| 14 | * [egeo-theme](https://github.com/Stratio/egeo-theme): The egeo components are thematizable. This is the official theme used in the Stratio's applications.
|
| 15 | * [egeo-starter](https://github.com/Stratio/egeo-starter): A Boilerplate project prepared for work with Egeo 1.x, Angular 2.x, TypeScript, Webpack, Karma, Jasmine and Sass.
|
| 16 |
|
| 17 | ## Table of contents
|
| 18 |
|
| 19 | * [About this repo](#about-this-repo)
|
| 20 | * [Getting Started](#getting-started)
|
| 21 | * [Dependencies](#dependencies)
|
| 22 | * [Installing](#installing)
|
| 23 | * [Work with egeo-cli](#work-with-egeo-cli)
|
| 24 | * [Contributing](#contributing)
|
| 25 | * [License](#license)
|
| 26 |
|
| 27 | ## About this Repo
|
| 28 |
|
| 29 | This repo includes the code of egeo-cli that parse code and generate README.md files.
|
| 30 |
|
| 31 | ## Getting Started
|
| 32 |
|
| 33 | ### Dependencies
|
| 34 |
|
| 35 | What you need to run this app:
|
| 36 | * [`node`](https://nodejs.org/es/) and `npm`
|
| 37 |
|
| 38 | ### Installing
|
| 39 |
|
| 40 | You can install Egeo-cli from npm:
|
| 41 |
|
| 42 | ```
|
| 43 | npm i -g @stratio/egeo-cli
|
| 44 | ```
|
| 45 |
|
| 46 | ### Work with egeo cli
|
| 47 |
|
| 48 | For now the only option implemented is for document a file in base a code comments, more info in [Wiki page](https://github.com/Stratio/egeo-cli/wiki/Document)
|
| 49 |
|
| 50 | ```
|
| 51 | egeo-cli [relative path to code]
|
| 52 | ```
|
| 53 |
|
| 54 | [More info](https://github.com/Stratio/egeo-cli/wiki)
|
| 55 |
|
| 56 | ## Contributing
|
| 57 |
|
| 58 | There are many ways to contribute to the Egeo-cli project. [Check our contribution section in the Wiki to learn more](https://github.com/Stratio/egeo-cli/wiki/How-to-contribute).
|
| 59 |
|
| 60 | ## License
|
| 61 |
|
| 62 | Egeo-cli is distributed under the Apache 2 license. You may obtain a copy of the license here at:
|
| 63 |
|
| 64 | [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|