-
Notifications
You must be signed in to change notification settings - Fork 95
Update downloading-community.md for clarity pt 1 #464
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,15 @@ | ||
| # Downloading the Talon Community User File Set | ||
|
|
||
| After installing Talon and a speech recognition engine, as described here you will need to download a user file set. This wiki discusses the Talon community user file set, so this page discusses downloading that specific user file set. | ||
| After installing Talon and a speech recognition engine, you will need to download a user file set. A user file set allows you to customize the files, documents, and settings for your personal use. | ||
|
|
||
| This can be done using two different methods, zip and Git. | ||
| There are two file options for downloading the user file set: a ZIP file and a Git. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As a clarification, Git is a program, so I would not put the word
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Okay, agreed. So we probably wouldn't describe it as a "file option" either. |
||
|
|
||
| The background to this choice is that if you use Talon for any period of time, you can expect the following: | ||
| The difference between the two options relates to how you want to update and personalize Talon. | ||
|
|
||
| - The community will update the user file set with bug fixes and new features, and you will want | ||
| to update your local copy of it. | ||
| - You might make your own changes to some of these files. | ||
| Possible updates you could make include: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What this section was originally trying to explain is that Git is useful for managing conflicts between your own personal changes and updates. It basically prevents you from having to re-download Community every time you want an update and then having to redo all of your personal changes manually. Git will allow automatically merging changes that do not conflict with each other, which is highly convenient. It also makes it easier to merge conflicting changes together. The choice is basically between (1) downloading a zip file, which is easier in the short term and does not require learning Git and (2) using Git to make merging your personal changes with updates easier in the long run. Do you think you understand what this page was trying to convey or do you have questions?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I think I understood the gist, but perhaps not all of the details. I'm revising the following sections that discuss ZIP vs. Git now, which discuss the short and long term advantages. |
||
|
|
||
| - Updates the community makes to the user file set to fix bugs and to add new features. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do you think of changing this sentence to say "Downloading updates to the Community user file set to fix bugs and to add new features"? and changing the next sentence to "Making your own changes to these files."?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sounds good! |
||
| - Changes you might want to make to these files. | ||
|
|
||
| --- | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page really did not make it clear in the first place that the reason for downloading a user file set is that Talon does not come with builtin commands. If you want voice commands, you have to download a file set or write them yourself. The reason why you need to download a file set for Talon does not have to do with customization, though you can customize them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that was only partially clear to me. I understood that Talon is customizable, but I wasn't sure in what ways. Perhaps providing an example like the voice commands would help. Also, a better definition of file set might help. I just pulled a basic one from the web.