Hanjp-IM / ibus-hanjp

An Input method that enables to write Japanese script by typing its pronunciation in Korean hangul script.
Other
22 stars 9 forks source link

Improve README.md #46

Open JSYoo5B opened 3 years ago

JSYoo5B commented 3 years ago

Known problems:

  1. Getting started is linking wrong url for cloning repository
    It's linking https://github.com/ubuntu-kr/hanjp-im.git
    (Seems this is legacy link for this project)
  2. Need to describe Build dependancy package
    (Also, It'd be better if you can describe how to install them by command line)
  3. Getting started describes only how to build, not how to use
    (Install hanjp-im to Desktop Environment, enabling hanjp-im, etc...)

Recommendation

  1. Move About Hanjp project and demo video at the top of README.md
    As the README.md is the entry point of the projects, It'd be better to give information on its top
  2. Describe currently supported platforms For end-user, supported platform may helpful for using Hanjp-IM Also it may invoke some minor & untracked platform users to contribute.
  3. Separate Getting started into other document such as INSTALL.md
    When the contents of README.md becomes longer, It'd be better to separate documents by its topic

Seems these issues are good first issue.

JSYoo5B commented 3 years ago

FYI, Build dependency packages in Ubuntu were following:

In a single command line:

$ sudo apt install libhangul-dev libibus-1.0-dev

onting commented 3 years ago

Good suggestions. I reckon your suggestions are,

  1. I've got missed. I'll fix for it.
  2. That's right. The dependency must be noted on documents clearly. Good pointing out.
  3. Stilll, the quick starting guide should be noted in most easily lookupable place. The detailed guide will be distributed in Korean docs, first. Then, I am organizing contents to English.

Thanks.

JSYoo5B commented 3 years ago

Some issues are resolved by @onting in commit 6138d7807bae50c8c2f04d617effdf6f9f329e02

But still, I think there are more tasks to improve README.md

I'll yield these issues as good first issue

onting commented 3 years ago

Yup, improvement for README can be a good starting point, I also believe. So, please feel free to talk with team.