Skip to content

Commit 7be685b

Browse files
committed
Add info to README: description, sample, credits.
1 parent 46e1501 commit 7be685b

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,43 @@
11
# GuideAutomator
2+
23
[![](https://badge.fury.io/js/guide-automator.svg)](https://badge.fury.io/js/guide-automator)
34
[![](https://img.shields.io/badge/node-%3E=6.9.1-brightgreen.svg)](https://nodejs.org/en/download/)
4-
[![](https://david-dm.org/allan1/guide-automator.svg)](https://david-dm.org/allan1/guide-automator)
5+
[![](https://david-dm.org/allan1/guide-automator.svg)](https://david-dm.org/aside-ufba/guide-automator)
56

67
[![](https://nodei.co/npm/guide-automator.png)](https://nodei.co/npm/guide-automator/)
78
> Automated User Guide Generation with Markdown
89
10+
GuideAutomator allows developers and technical writers to create user manuals with screenshots that are always in sync with the latest version of the application being documented. For that end, it takes as input a Markdown file containing the user manual text with short JavaScript chunks that determine how to capture each screencast.
11+
12+
Sample GuideAutomator input:
13+
14+
## How to find GuideAutomator
15+
16+
Open the Bing website and type `GuideAutomator aside-ufba`:
17+
18+
```javascript
19+
get('https://bing.com/');
20+
fillIn('#sb_form_q', 'GuideAutomator aside-ufba');
21+
takeScreenshotOf('#sb_form>div', true);
22+
```
23+
24+
Press *Enter*. The first result should be what you are looking for:
25+
26+
```javascript
27+
submit('#sb_form');
28+
takeScreenshotOf('#b_results>li:nth-child(1)', true);
29+
```
30+
31+
Corresponding output:
32+
33+
![GuideAutomator output](extras/sample.png)
34+
35+
GuideAutomator was proposed by professor [Rodrigo Souza](https://github.com/rodrigorgs) and originally implemented by [Allan Oliveira](https://github.com/rodrigorgs) as part of his [Bachelor's thesis](https://repositorio.ufba.br/ri/bitstream/ri/20947/1/monografia-allan-versao-final.pdf). The project is now being maintained by [Welbert Serra](https://github.com/welbert). The project is being developed in the context of [aSide](https://translate.google.com/translate?sl=pt&tl=en&js=y&prev=_t&hl=en&ie=UTF-8&u=http%3A%2F%2Fwiki.dcc.ufba.br%2FAside%2F&edit-text=&act=url), a research group at the [Federal University of Bahia](https://en.wikipedia.org/wiki/Federal_University_of_Bahia) specialized in software design and evolution.
36+
37+
---
38+
39+
## Summary
40+
941
- [Installation](#installation)
1042
- [Prerequisites](#prerequisites)
1143
- [Linux](#linux)
@@ -306,11 +338,3 @@ See [raw](https://raw.githubusercontent.com/Allan1/guide-automator/master/exampl
306338
[Selenium Documentation](https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/chrome_exports_Driver.html)
307339

308340
[back to top](#guideautomator)
309-
310-
## Author
311-
### [Allan Oliveira](https://github.com/Allan1)
312-
313-
### Contributors
314-
* [Welbert Serra](https://github.com/welbert)
315-
316-
[back to top](#guideautomator)

extras/sample.png

42.9 KB
Loading

0 commit comments

Comments
 (0)