Skip to content
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

Jump to bottom

Improve grammar/wording in README.md #909

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Improve grammar/wording in README.md #909

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
# Genie Parser

Genie is both a library framework and a test harness that facilitates rapid
development, encourages re-usability, and simplifies writing test automation. Genie
bundled with the modular architecture of pyATS framework accelerates and
development, encourages re-usability, and simplifies writing test automation.
Genie bundled with the modular architecture of pyATS framework accelerates and
simplifies test automation leveraging all the perks of the Python programming
language in an object-orienting fashion.
language in an object-oriented fashion.

pyATS is an end-to-end testing ecosystem, specializing in data-driven and
reusable testing, and engineered to be suitable for Agile, rapid development
Expand All @@ -20,11 +20,11 @@ general public starting early 2018 through [Cisco DevNet].
[Cisco DevNet]: https://developer.cisco.com/

This is a sub-component of Genie that parses the device output into structured
datastructure.
data.

# Installation

The package is automatically installed when pyATS gets installed
The Genie package is automatically installed when pyATS gets installed.

```
$ pip install 'pyats[full]'
Expand Down Expand Up @@ -62,10 +62,11 @@ Change logs can be found [here](changelog/CHANGELOG.md).

[Guide]

[Guide]: https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/writeparser/writeparser.html#
[Guide]: https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/writeparser/writeparser.html


YouTube Video: <How to write a Genie parser for Cisco!> https://youtube.com/watch?v=ibLNilSfdTc (Thank you! @Jmahaja1)
YouTube Video: <How to write a Genie parser for Cisco!> https://youtube.com/watch?v=ibLNilSfdTc
(Thank you! @Jmahaja1)


Once you create a new parser, don't forget to check 1, 2, and 3;
Expand All @@ -75,7 +76,7 @@ if you only update the parser class without modifying/creating the schema, pleas
- [ ] 3. make sure GitHub Actions checks passed.

# How to write a 'changelog' for your contribution:
1. Become familiarized with the examples at [changelog/undistributed/template.rst](https://github.com/CiscoTestAutomation/genieparser/blob/master/changelog/undistributed/template.rst). Changelogs must be written in the same style as the examples found there:
1. Become familiar with the examples at [changelog/undistributed/template.rst](https://github.com/CiscoTestAutomation/genieparser/blob/master/changelog/undistributed/template.rst). Changelogs must be written in the same style as the examples found there:
```
--------------------------------------------------------------------------------
Fix
Expand Down
Loading