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

improve user documentation #274

Open
torbengb opened this issue Apr 18, 2019 · 3 comments
Open

improve user documentation #274

torbengb opened this issue Apr 18, 2019 · 3 comments

Comments

@torbengb
Copy link
Member

Is your feature request related to a problem? Please describe.
We already had the issue #15 to generate the initial, rudimentary user guide. It contains the essentials but it can be improved, as pointed out in more recent issues (#265).

Describe the solution you'd like

  • Rather than two sections buried in the README, we should create proper pages including screenshots.
  • Perhaps build a real website (perhaps with GitHub Pages?), or extend the wiki?
  • Include some sort of user guide in the package itself.
  • Determine most user-friendly format (considering maintainability by us).
@torbengb torbengb self-assigned this Apr 18, 2019
@torbengb torbengb added this to Candidates in 1.2.0 via automation Apr 18, 2019
@torbengb torbengb moved this from Candidates to In progress in 1.2.0 Apr 18, 2019
@angelod1as
Copy link

I know this is an old issue but I was about to open another one with the same content.

As a programmer that doesn't write python, I'm very confused on how to run this locally and test my CSVs so I can open a PR.

And, let's suppose I already have the bank I want in the list... how do I run it? There's no (visible) docs on how to run the program.

I'd love to collaborate with docs on this but python is def not my strength, so I can review and comment any PRs under this theme.

@nocalla
Copy link
Member

nocalla commented Oct 11, 2023

The docs aren't amazing, it's true, but there are instructions on how to run the script here.

@angelod1as
Copy link

@nocalla I stand corrected, you are right and I missed that. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
1.2.0
  
In progress
Development

No branches or pull requests

3 participants