From 61decce6a8b9910fb6c87de94c0e7c7604802e47 Mon Sep 17 00:00:00 2001 From: dethan3 Date: Sat, 7 Sep 2024 01:58:14 +0800 Subject: [PATCH] Update readme 1.0 --- README.md | 57 ++++++++++++++++++++++++++----------------- sync_status_readme.py | 4 +-- 2 files changed, 37 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 0bdc611..c7a46a1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# 残酷共学模版 +# Starknet 残酷共学 -> 本文档为创建残酷共学的通用模版 - 中文版，请根据模版结构来进行你的残酷共学的内容填充 - -# {本期残酷共学标题} +> Starknet 残酷共学 by LXDAO & Starknet Astro & AAStar ## 什么是残酷共学（Intensive Co-learning）？ @@ -23,34 +21,49 @@ 如果你有任何有关残酷共学的疑问或者想法，请到 [残酷共学 Telegram 群](https://t.me/LXDAO/6215) 联系我们。 -## {本期残酷共学名字}介绍 - -请写清楚本期残酷共学： +## Starknet 残酷共学 -- 举办的原因 -- 谁/哪个组织发起的，以及合作方 -- 一共几期 -- 共学形式：自主学习、定期答疑、线上课程 、线下 Meetup (请自由组合或新增新的共学方式) -- 本次共学目标或产出 -- 适合人群 -- 负责人、助教、导师的简单介绍以及联系方式 +Starknet 残酷共学是由 LXDAO、Starknet Astro、AAStar 联合发起，旨在帮助大家更好地了解、学习、部署 Starknet 网络并加以实战。 ## 共学内容 -请写清楚共学内容的链接以及使用方法，如果欢迎新增共学内容，也请说明一下，但请负责人保证共学的内容准确、质量、数量、符合本次共学难度。 -如果有提供的具体的课程学习计划，也请在此说明。 +主要参考 +Starknet Book +cairo book +# 工具准备（前面应该讲过了，略过，或者补充前面没讲的） + +asdf(可选) [Getting Started | asdf (asdf-vm.com)](https://asdf-vm.com/guide/getting-started.html#official-download) +scarb [Scarb, the Cairo and StarkNet development toolchain (swmansion.com)](https://docs.swmansion.com/scarb/) +starkli [Starknet 之书 - The Starknet Book](https://book.starknet.io/zh-cn/title-page.html) +Katana [Katana: 本地节点 - The Starknet Book](https://book.starknet.io/zh-cn/ch02-05-katana.html) + +# 编写合约 + +（看时间，可以copy也可以手写） +有两个版本，用openzepplin的和自己写的，二选一 + +- 用foundry来开发和测试 +# 部署合约 + +- 部署到katana +- 部署到测试网 +# 验证合约 +- sncast verify +# 与合约交互 +- 区块浏览器 +- 前端 +# 前端代码（略） + ## 共学时间 -- 报名截止时间：(请写明时区) -- 本期共学开始时间：(请写明时区) +- 报名截止时间：9.9 - 9.15 +- 本期共学开始时间：9.18 - 本期共学持续时间：21 天（我们默认为 21 天，21 天为养成一个新习惯的周期，可根据自己的内容和课程来制定，但不易过长或过短） ## 共学规则 -（以下内容为 LXDAO 共学活动默认规则，你可以根据自己共学的情况进行修改，请注意我们有自动化脚本进行打卡记录的更新，请确保如果修改规则要将脚本规则一并修改） - - 报名规则：请在报名截止时间前进行报名，共学一旦开始后，不得中途加入 - 打卡规则：建议你每天学习 30 ～ 60 分钟，并将学习笔记提交，我们会自动更新你的打卡状态，每周有两次请假的机会，超过后状态变为 ❌，视为本次共学失败 - 激励规则：（如果有具体的激励方式请写明）（没有激励方案默认文案参考：通过本次共学学到的知识，就是你给自己最好的激励！） @@ -66,7 +79,7 @@ - Step02：复制 Template.md 创建你的个人笔记文件，并根据文档指引填写你的信息，并将文件重命名为你的名字：YourName.md。 - Step03：创建一个 PR 到当前仓库，本残酷共学助教会对你的 PR 进行 review，review 通过后，你的 PR 会被 merge 到 main 分支，这个时候你会收到邀请加入这个仓库 contribution 的邮件，接受邀请后，你会自动获得 main 分支的 push 权限。 - Step04：完成以上三个步骤，恭喜你报名成功，后续就可以将你的学习记录直接 push 到 main 分支进行更新。 - - 请加入 xxx 群组保持交流：（请添加你创建的群组链接)。加入群组后请在群里报到一下方便助教记录。 + - 请加入微信群组保持交流：。加入群组后请在群里报到一下方便助教记录。 - 打卡： - 报名成功后，你将拥有 main 分支的 push 权限，你需要将每天学习笔记按日期更新到你的 YourName.md 文档中，提交更新后，我们会自动更新你的打卡状态到下面的打卡记录表。 @@ -87,7 +100,7 @@ -| Name(GitHub ID) | 6.24 | 6.25 | 6.26 | 6.27 | 6.28 | 6.29 | 6.30 | 7.01 | 7.02 | 7.03 | 7.04 | 7.05 | 7.06 | 7.07 | 7.08 | 7.09 | 7.10 | 7.11 | 7.12 | 7.13 | 7.14 | +| Name(GitHub ID) | 9.18 | 9.19 | 6.26 | 6.27 | 6.28 | 6.29 | 6.30 | 7.01 | 7.02 | 7.03 | 7.04 | 7.05 | 7.06 | 7.07 | 7.08 | 7.09 | 7.10 | 7.11 | 7.12 | 7.13 | 7.14 | | --------------- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | diff --git a/sync_status_readme.py b/sync_status_readme.py index 922c122..8072834 100644 --- a/sync_status_readme.py +++ b/sync_status_readme.py @@ -8,9 +8,9 @@ # Constants START_DATE = datetime.fromisoformat(os.environ.get( - 'START_DATE', '2024-06-24T00:00:00+00:00')).replace(tzinfo=pytz.UTC) + 'START_DATE', '2024-09-16T00:00:00+00:00')).replace(tzinfo=pytz.UTC-8) END_DATE = datetime.fromisoformat(os.environ.get( - 'END_DATE', '2024-07-14T23:59:59+00:00')).replace(tzinfo=pytz.UTC) + 'END_DATE', '2024-10-20T23:59:59+00:00')).replace(tzinfo=pytz.UTC-8) DEFAULT_TIMEZONE = 'Asia/Shanghai' FILE_SUFFIX = os.environ.get('FILE_SUFFIX', '_EICL1st.md') README_FILE = 'README.md'