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.

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

README very hard to read, please rewrite, add example. #104

Open
sanjarcode opened this issue Aug 30, 2023 · 2 comments
Open

README very hard to read, please rewrite, add example. #104

sanjarcode opened this issue Aug 30, 2023 · 2 comments

Comments

@sanjarcode
Copy link

sanjarcode commented Aug 30, 2023

I just wish to add run a command with a home screen icon. Why is this so hard?

  1. What's the difference between .shortcuts, .shortcuts/tasks and .shortcut/icons. Which of these do I need to add an icon?
  2. Instead of explaning internals, just add steps.
  3. Please use toggle boxes for non-normal settings <details><summary></summary></details>.

can a generator command be written for this? or we can have a single config file.

@sylirre
Copy link
Member

sylirre commented Aug 30, 2023

Short explanation:

  • .shortcuts: to store scripts that are run as normal Termux session.
  • .shortcuts/tasks: directory where to store scripts that always run in background. No Termux session created. This is alternative to above directory. Don't place your script into both.
  • .shortcuts/icons: directory to store icon files - obviously you can't have icon within Shell script text file, so it should be a separate file. Icons must be named like scriptname.png: if your script name is script.sh, then icon name should be script.sh.png. Otherwise widget won't be able to associate script with icon file. (NOTE: icon is optional!)

Not a great design, but so far no one contributed to make it better.

@elig0n
Copy link
Contributor

elig0n commented Aug 11, 2024

@sylirre There's also dynamic shortcuts at ~/.termux/widget/dynamic_shortcuts which are not yet incorporated to a published released but show up in README nonetheless

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants