haskell / haskell/binary

Improve README.md

未关闭
#28 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Haskell
星标
120
派生
70
PR 合并指标
30 天内没有已合并 PR

描述

The README.md file has been converted to Markdown and been slightly extended.

Here are some further changes I'd like to see:

Not sure if it's still portable to Hugs. We claim it is, but I doubt it.

The section about "Using binary". I think this section is not too helpful. It could be more structured of the alternatives and with links to the relevant haddocks.

Deriving binary instance section. This is outdated and missleading. We can now generate instances with GHCs generics. A small example of how to do so, or link to the haddocks, would be better suiting.

贡献指南

这个仓库没有索引到贡献指南

调研方向

首先阅读 README.md,重点关注 Hugs 的可移植性声明、“Using binary”部分以及 deriving 部分。编辑前检查当前的 Haddocks 和 GHC generics 指南;当 README 准确描述可移植性、通过相关链接介绍使用替代方案,并展示或链接到现代的实例生成方式时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
haskell
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。