Update README

Question

Update README

chshersh opened this issue 3 years ago · 7 comments

Current README duplicates previous co-log README. Ideally, we want to see here something like in the following README of prolens with a short description and simple usage.

https://github.com/kowainik/prolens#readme

Answer 1 · 2021-11-04T12:57:21.000Z

I want to do it. Can you guide me?

Answer 2 · 2021-11-04T16:52:06.000Z

Hi @NguyenLyy 👋🏻

Thanks for your interest! A good starting point would be to replace the co-log-polysemy README with a copy-paste of prolens README and change the package name. Most sections of that README probably can be skipped. I believe, you don't need to describe the goals of co-log-polysemy, its features and comparison to other libraries, this would be too much to ask 😅 But the "How to use" section has a generic template. And you can take a general introduction description of the package from the .cabal file.

Answer 3 · 2021-11-09T17:36:48.000Z

#6 check here.

Answer 4 · 2021-11-15T17:45:12.000Z

I have a confusion regarding dependencies that should be added for co-log-polysemy in .cabal files.

my #6 PR mentions -
build-depends: base ^>= LATEST_SUPPORTED_BASE
, co-log-polysemy ^>= LATEST_VERSION

shouldn't that be -
build-depends: base ^>= LATEST_SUPPORTED_BASE
, co-log-core ^>= LATEST_VERSION
, polysemy >= LATEST_VERSION

Answer 5 · 2021-11-15T17:52:52.000Z

@udaycruise2903 Yes, you're correct. The example now imports Polysemy explicitly so it should depend on this library as well. Would you like to open a small PR with this small fix? 🙂

Answer 6 · 2021-11-16T14:58:23.000Z

review #7. It has the fix.

Answer 7 · 2021-11-18T22:05:46.000Z

I believe this is finally fixed 🙂
Thanks @udaycruise2903!