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

Expanding on tutorial for downloading and installing #95 #116

Merged

Conversation

CentreMetre
Copy link
Contributor

@CentreMetre CentreMetre commented Sep 2, 2023

Updated README.md in root. Added tutorial directory. Added instructions for downloading Java for Windows, Linux, and MacOS. Added instructions for installing Java on Windows and setting environment variables on Windows. Added instructions for downloading and running GlobalQuake. #95

xspanger3770 and others added 3 commits August 31, 2023 21:27
Updated README.md in root. Added tutorial directory. Added instructions for downloading Java for Windows, Linux, and MacOS. Added instructions for installing Java on Windows and setting environment variables on Windows. Added instructions for downloading and running GlobalQuake.
@CentreMetre CentreMetre marked this pull request as ready for review September 2, 2023 03:00
Made " usage more consistent
@xspanger3770
Copy link
Owner

So far looking very promising!

Fixed format errors. Added Wikipedia lists to Debian and Redhat derivatives. Improved some things.
Clarified that installing could be different depending on OS/Desktop environment
Clarified it may as for password on linux ubuntu. Added RPM/fedora java install tutorial.
@xspanger3770
Copy link
Owner

Hi!
I looked at your current state of the tutorial and even though all parts are not finished, I think that the tutorial already has good informative value and I would like to merge it. What do you think? Do you want to add something else to it?

@CentreMetre
Copy link
Contributor Author

Yes I think it would be fine to merge. What else do you think needs doing? There's mac which I've set up #125 up for, but if there's anything else you think need adding ill make sure to.

@xspanger3770
Copy link
Owner

Surely, you can leave the MAC tutorial for another time / another person.
The last bit that would be great to complete is in the section of setting environment variables for Linux, I see that it is still under construction, and also to add some kind of link to the tutorial to the main README.md file would be nice to have.

@CentreMetre
Copy link
Contributor Author

Ah yea i complete forgot about the linux environment variables, ill get that done when i can get to an emulator. And ill add the link in the main readme to the tutorial readme.

@CentreMetre
Copy link
Contributor Author

Quick question, how should the link be added, since the URL doesnt yet exist for me to add to the main read me? Should i just put 'link coming soon' or something like that? And then add the link when it gets merged?

Added downloading section and clarified that the link to the tutorial is coming soon
@xspanger3770
Copy link
Owner

Ah, you are right about the URL... don't worry, you can put "link coming soon" and I can add it later myself :D

@YacineBoussoufa
Copy link
Contributor

Sorry, I haven't followed this PR, will the Tutorial be added to the Repository Wiki or in a Website, if I read well? I think that using the wiki is much better.

For reference wiki of ObsPy

@CentreMetre
Copy link
Contributor Author

I think a wiki is a good idea, its a better place for end user documentation i think. Maybe this question would be better as an issue?

@xspanger3770
Copy link
Owner

Wiki definitely sounds like a great idea and I haven't even discovered this functionality yet :D

@xspanger3770
Copy link
Owner

I think that you can edit the wiki right away now. Perhaps create a new page called installation tutorial and paste it there?
Apparently there is no need to have the files inside the folders..

@CentreMetre
Copy link
Contributor Author

Sorry for the bit of delay for such a small outcome, but I think we don't need an environment variable tutorial for Linux since the way Linux handles packages, it just automatically knows where it is since it just installed since the package decides it (in /usr/, for ubuntu at least) unless they use a portable/Self compiled version, as opposed to windows where the user can decide where to install it. Also to be honest I think if someone is using Linux and they do use the portable version they probably know how to set this, or if they don't know (I'm also one of the people who doesn't 100% know...) how to look it up.

So I think we can possibly leave this out. Maybe at least just for now and if people do have issues with it we could add it then.

@xspanger3770
Copy link
Owner

I finally got the time to merge your tutorial and integrate it with the current readme. Thanks a lot for your help and I hope many people in the future will find the tutorial helpful :)

@xspanger3770 xspanger3770 merged commit d8f1ec8 into xspanger3770:readme Oct 18, 2023
This pull request was closed.
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

Successfully merging this pull request may close these issues.

3 participants