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

More prominently feature setup instructions #168

Open
R030t1 opened this issue Jul 23, 2020 · 3 comments
Open

More prominently feature setup instructions #168

R030t1 opened this issue Jul 23, 2020 · 3 comments

Comments

@R030t1
Copy link

R030t1 commented Jul 23, 2020

I spent about 30min trying to figure out how to get the assembly linked into my project. Can you tell users that they need to set the installation namespace and also click the tickmark to install it? Did I miss that somewhere?

@3F
Copy link
Owner

3F commented Jul 23, 2020

Welcome everyone who is willing to provide clearer steps in our documentation!

Can you tell users that they need to set the installation namespace

They don't need. Because they can freely use anything including global. Thus for convenience it will even activate an actual namespace in selected project by default. That's why it can be used without any changes in most cfg.

and also click the tickmark to install it?

Yes, to install you need to click install.

Did I miss that somewhere?

For the mentioned things we have this today:

Feel free to improve our wiki or open PR.
Please don't forget that different configurations are required in different cases. Therefore I'd recommend only clarify your case for common use.

Thanks.

@R030t1
Copy link
Author

R030t1 commented Jul 23, 2020

Thanks for the response. Do you mind if I prepare some small instructions to add to the main README? I checked the wiki and examples however none of them referenced the configuration GUI. I understood what most of the settings do but kept missing the tickmark next to the entire lower section that made sure the assembly would be installed into the project.

Putting it somewhere prominent is most helpful.

@3F
Copy link
Owner

3F commented Jul 23, 2020

I think it will be nice to improve exactly the existing 'Quick-start' page in wiki because this page is referenced in many places as a starting point. And this is a good point to explain there some steps in details. Or better new page in addition to Quick-start (just to keep this page short to begin with)

I understood what most of the settings do but kept missing the tickmark next to the entire lower section that made sure the assembly would be installed into the project.

This is a good moment to suggest your ideas into our GUI part. Just open PR and we'll review it together!

@3F 3F mentioned this issue Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants