search

jmakhack / myanimelist-cli

Minimalistic command line interface for fetching user anime data from MyAnimeList.
https://aur.archlinux.org/packages/mya-git
MIT License
11 stars 15 forks source link

[TASK] Add instructions on how to install from source #33

Closed jmakhack closed 1 year ago

jmakhack commented 1 year ago

Task Context

Currently, there are no installation instructions for this project.

This task is to add the installation instructions to the project's README for different operating systems.

Acceptance Criteria

Add instructions on how to install this program from source for the following operating systems:

  1. Windows
  2. MacOS
  3. Linux

Place these instructions between the Example and Code of Conduct sections of the README.

Additional Context

For an idea of what commands are needed to install this program on different operating systems, you can take a look at the installation instructions for https://github.com/pystardust/ani-cli. The installation from source instructions for Windows, MacOS, and Linux should be very similar for this project.

For any questions or discussions, join the Discord to meet and engage with other contributors!

Discord

VividhPandey003 commented 1 year ago

Hey, I am a beginner to Open Source and really looking forward to contribute to this repo. Could you please assign this issue to me

jmakhack commented 1 year ago

Sure @VividhPandey003! It's assigned to you now. Just let me know if you have any questions.

VividhPandey003 commented 1 year ago

Hey @jmakhack I currently have a MacOS. Are the install instructions for myanimelist-cli same as the reference doc you shared. Also can I discuss this issue with you on Discord or here only works fine

jmakhack commented 1 year ago

Hey @VividhPandey003, Discord is preferable for discussions. I'll ping you there :)