Documentation: Update README to match the current implementation

未关闭
#40 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

先阅读 README,并将其中的 char_simple 和 string_simple 示例与当前的 main 实现进行比较。更新 README 中的代码,使其能够与最新的 main 一起工作,然后修改“给读者的练习”部分;完成的标准是示例保持最新且可用。

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

描述

Why?

Currently it refers to char_simple and string_simple in many places, but they were deprecated.

What?

  • Rewrite the code from README and make sure that it works with the latest main.
  • Change the excercise for the reader section.
主要语言
Lean
星标
37
派生
8
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

argumentcomputer/Megaparsec.lean 的其他 Issue

查看 argumentcomputer/Megaparsec.lean 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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