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

Getting Started Section #24

Closed
johnmathews opened this issue Feb 25, 2021 · 5 comments
Closed

Getting Started Section #24

johnmathews opened this issue Feb 25, 2021 · 5 comments
Labels
docs Code documentation

Comments

@johnmathews
Copy link

This looks super interesting and I'd like to use it, but I'm not sure how to get started.
I've installed the requirements ok, but how do I begin using it?
It would be really useful to have a "getting started" section in the readme.

@dvergeylen
Copy link

Some insights (not a getting started guide but some guidance for non techies to use this):
https://news.ycombinator.com/item?id=26260895
https://github.com/DidierRLopes/GamestonkTerminal/issues/2#issuecomment-785552454

@johnmathews
Copy link
Author

Great thanks. python ganestonk_terminal.py was what i was looking for.

@dvergeylen
Copy link

dvergeylen commented Feb 25, 2021

Actually python gamestonk_terminal.py implies your terminal's current working directory is the same than gamestonk_terminal.py file location. But you can start it from wherever you want either giving it a relative path from where you currently are or an absolute path (more info).

Have fun!

@DidierRLopes
Copy link
Collaborator

Hey,

Yes, this is a good call. And I should have done it earlier one. Believe me that if I knew that so many people would be interested in the project, I would of!

I'm cleaning whole installation process, and then I'll write up a Getting Started document. With docker image I think this may make life much easier to non-devs.

@aia aia added the docs Code documentation label Mar 6, 2021
@DidierRLopes
Copy link
Collaborator

Hey, let me know if this does the job:

https://github.com/DidierRLopes/GamestonkTerminal#getting-started

Will close this issue. Re-open it if you have any suggestions to improve this.

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

No branches or pull requests

4 participants