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

Docs improvement for ahkpm #1

Open
Norlandz opened this issue Jun 17, 2024 · 2 comments
Open

Docs improvement for ahkpm #1

Norlandz opened this issue Jun 17, 2024 · 2 comments

Comments

@Norlandz
Copy link

Add docs for those who dont know ahkpm:

  • Install ahkpm
  • Use ahkpm install gh:jasonsparc/dsvparser-ahk2 in your project dir
  • Import it by #Include %A_ScriptDir%\ahkpm-modules\github.com\jasonsparc\dsvparser-ahk2\dsvparser-ahk2.ahk
@Norlandz Norlandz changed the title Docs improvement Docs improvement for ahkpm Jun 17, 2024
@jasonsparc
Copy link
Owner

jasonsparc commented Jun 18, 2024

I don't think a lot of AHK users are familiar with package managers; hence, the initial motivation not to mention it in the README. After all, if you're aware of ahkpm, you might even already know how to use it, right?

Perhaps we could mention it briefly in the README, something like,

If you're familiar with package managers, check out ahkpm ...

And then somehow provide a link to this issue.

That way we don't end up confusing people that don't want or are unaware of ahkpm (or package managers in general). Personally, I like to keep the “Basic usage” section of my README as short as possible. Perhaps we could even enclose the instructions in a collapsed <details> tag instead.

What do you think?

@Norlandz
Copy link
Author

@jasonsparc

Any way will work for me.

The intension of this post is just to simplify the work for those who may try to use ahkpm for first fews times.

I think adding a section / link for advanced users for ahkpm can be helpful .

(Its good to popularize the idea of ahkpm,
it was some project mentioned ahkpm so that i began to know the good existence of ahkpm.)

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

2 participants