Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add basic README for RPC parser #324

Merged
merged 2 commits into from
Sep 29, 2021
Merged

Conversation

jacobkeeler
Copy link
Contributor

Adds basic README file to describe the usage of the markdown generator script in the RpcParser subdirectory.

The markdown generator requires the use the interface parser included in this project, which has its own set of dependencies. These dependency libraries are described in the interface parser's `requirements.txt` and should be pre-installed by the following command:

```bash
pip3 install -r ../InterfaceParser/requirements.txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor suggestion. pip may not be installed by default on the system so we might want to include a pip installation step (like we did for the HMIs https://github.com/smartdevicelink/generic_hmi#dependencies)

Suggested change
pip3 install -r ../InterfaceParser/requirements.txt
sudo apt install python3 python3-pip -y
pip3 install -r ../InterfaceParser/requirements.txt

@jacobkeeler jacobkeeler merged commit 20d64e6 into develop Sep 29, 2021
@jacobkeeler jacobkeeler deleted the feature/rpc_parser_readme branch September 29, 2021 15:19
@jacobkeeler jacobkeeler mentioned this pull request Sep 29, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants