search

deejcunningham / skill-score

Deprecated Mycroft skill to report latest MLB scores
MIT License
3 stars 5 forks source link

Edit documentation #7

Open ljl7123 opened 6 years ago

ljl7123 commented 6 years ago

My university technical writing course has an assignment which involves editing documentation on GitHub repositories as practice in real world settings. Edits may involve aspects like style, structure, and concision. Existing style guidelines would be taken into account. The following is one of the resources I would be using:

https://jacobian.org/writing/technical-style/

Would anyone mind if I add or propose edits to documentation in this repository? It would really help me out!

deejcunningham commented 6 years ago

Feel free to contribute! Take a look at the Mycroft skills documentation, it should point you in the right direction.

ljl7123 commented 6 years ago

Thanks @deejcunningham !

ljl7123 commented 6 years ago

Hi @deejcunningham ! My understanding is that your app enables Mycroft to answer user questions about MLB scores (please correct me if I'm mistaken).

I was thinking of adding some stuff to the README file and was hoping you could clarify the following:

  1. If the user asks, "What is the Royal's score", what would Mycroft's response be? (i.e. the general answer format)

  2. Is "What is (Team)'s score" the only use case or way of asking Mycroft for information?

Thanks in advance!

deejcunningham commented 6 years ago

Your understanding is correct. You should try out Mycroft and the skill to get an idea for how it is used if you are able. Let me know if you need help getting it going.

1) I am working to diversify utterances (ways the user can the user can phrase things) but currently yes that is the only way. If there is a game for that team in progress, Mycroft will answer "The TEAM are winning/losing SCORE to SCORE against the OPPONENT in the top/middle/bottom/end of the INNING." If there isn't a game for that team in progress, Mycroft will give the latest score for that team i.e. "The TEAM won/lost against the OPPONENT yesterday/two days ago."

2) Currently yes, but there are plans for diversifying use cases in the near future. A couple are written down as issues (look for enhancement label), but asking what time a game starts, who a team is playing, when the next game is, where a game is taking place, when important season dates are (spring training, opening day, etc), what a team's record is, having Mycroft give a play-by-play and/or notify of runs scored/innings passed, and possibly reporting of player stats are all viable. Not to mention diversifying into other sports/leagues.

Thanks!

ljl7123 commented 6 years ago

Thanks @deejcunningham ! A couple more questions:

  1. What are the prerequisites for installing the application?

  2. What do I need to do to install and deploy the application?

Thanks!

ljl7123 commented 6 years ago

(I made a separate issue for my recent PR because my assignment guidelines require them. I plan on doing 1 PR for each README section that I add/edit.)

deejcunningham commented 6 years ago

  1. To use this skill you need Mycroft (which has its own set of prerequisites) and I would recommend using Mycroft Skills Manager (msm) to install. It will take care of installing into the proper directory and with the proper requirements.

  2. The skill is still in initial development, so for now... First install Mycroft (following the directions on their website/Github), second install msm (I believe you can pip install msm), then install the skill via msm install https://github.com/deejcunningham/skill-score.

HOWEVER, it will eventually be listed on the Mycroft Skills Repository and then all one needs to do to install it is ask Mycroft to install it.

Once I submit a PR with Mycroft (which I may have already done, just not correctly), it will essentially be 'in production' and I will start working on a dev branch while adding new features, then will submit PRs to Mycroft when I want to push an update to production.

ljl7123 commented 6 years ago

@deejcunningham Thanks! I'll make a PR for the installation section in the README.