Metadata-Version: 2.1
Name: aadoc
Version: 0.0.1
Summary: A tool that automatically generates documentation from Automation Anywhere comments
Home-page: https://dillir07.github.io/aadoc/
Author: Dilli Babu R
Author-email: dillir07@outlook.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

AADOC

    A tool to generate Documentation from AA Comments
    
    Explore the docs Â» (https://github.com/dillir07/aadoc)

    View Demo (https://github.com/dillir07/aadoc)
    Â·
    Report Bug (https://github.com/dillir07/aadoc/issues)
    Â·
    Request Feature (https://github.com/dillir07/aadoc/issues)

## Table of Contents

- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
- [Usage](#usage)
  - [aadoc "input_folder_path_in_quotes" "optional output path"](#aadoc-%22inputfolderpathinquotes%22-%22optional-output-path%22)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## About The Project

AADoc is a tool created for generating Doumentation from Automation Anywhere Code's comments. 

### Built With

* Python

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* python
* pip

<!-- ```sh
pip install npm@latest -g
``` -->

### Installation

1. Install AADoc using pip
```sh
pip install aadoc
```




## Usage



### aadoc "input_folder_path_in_quotes" "optional output path"




## Roadmap

See the [open issues](https://github.com/dillir07/aadoc/issues) for a list of proposed features (and known issues).




## Contributing






## License

Distributed under the GPLv3 License. See `LICENSE` for more information.




## Contact

Dilli Babu R - [@dillir07](https://twitter.com/dillir07) - dillir07@outlook.com

Project Link: [https://github.com/dillir07/aadoc](https://github.com/dillir07/aadoc)












[contributors-shield]: https://img.shields.io/github/contributors/dillir07/aadoc?style=flat-square

[contributors-url]: https://github.com/dillir07/Best-README-Template/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/dillir07/aadoc?style=flat-square

[forks-url]: https://github.com/dillir07/Best-README-Template/network/members

[stars-shield]: https://img.shields.io/github/stars/dillir07/aadoc?style=flat-square

[stars-url]: https://github.com/dillir07/Best-README-Template/stargazers

[issues-shield]: https://img.shields.io/github/issues/dillir07/aadoc?style=flat-square

[issues-url]: https://github.com/dillir07/Best-README-Template/issues

[license-shield]: https://img.shields.io/github/license/dillir07/aadoc?style=flat-square

[license-url]: https://github.com/dillir07/aadoc/blob/master/LICENSE

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/dillir07
[product-screenshot]: images/screenshot.png

