Skip to content

Add comprehensive README.md - #20

Merged
hzhangxyz merged 8 commits into
mainfrom
copilot/add-readme-file
Nov 25, 2025
Merged

Add comprehensive README.md#20
hzhangxyz merged 8 commits into
mainfrom
copilot/add-readme-file

Conversation

Copilot AI commented Nov 24, 2025

Copy link
Copy Markdown
Contributor

Completed comprehensive README.md for the multi-language deductive system:

  • Explore repository structure and understand the project
  • Review all TypeScript, Python, and C++ source files
  • Create comprehensive README.md with all sections
  • Address initial code review feedback
  • Address PR feedback from @hzhangxyz:
    • Remove emphasis on "automated theorem proving" - replaced with more modest "logical inference" and "iterative inference"
    • Added new "Architecture" section clearly showing C++ as the core with Python and TypeScript as bindings
    • Updated installation sections to explain the binding relationship
    • Reviewed all remaining files in include/ds/ and pyds/ to ensure no information is missing
  • Improve intro readability (split long sentence)
  • Additional feedback:
    • Added match example in Core Concepts section (from tsds/tsds.mts comments)
    • Removed buffer_size calls from JS and Python examples (only needed outside search)
    • Fixed examples to be runnable with all required axioms (modus ponens + 3 schema axioms + !!X premise)
    • Added target checking and termination to C++ example (using text_to_rule, memcmp, and while loop)
    • Added missing cstdio include for printf

The README now clearly shows that:

  • C++ is the core implementation
  • Python bindings are built with pybind11
  • TypeScript bindings are built with Emscripten (WebAssembly)
Original prompt

This section details on the original issue you should resolve

<issue_title>Add readme.md</issue_title>
<issue_description></issue_description>

<agent_instructions>这是一个多语言接口的项目,ts的部分你参考 /tsds/tsds.mts python的部分你参考 pyds/下的各个文件(这些文件都比较短,你可以方便的读取),cxx部分代码比较多,但是头文件在include/ds里面,里面有注释。</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits November 24, 2025 18:11
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Copilot AI changed the title [WIP] Add readme.md to the project Add comprehensive README.md Nov 24, 2025
Copilot AI requested a review from hzhangxyz November 24, 2025 18:15

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

挺好,但是

  1. 不要强调自动证明,这个太强了
  2. 你需要注意python和ts都是基于cxx的,我希望你能体现出来

另外,你最好阅读一下其他include/ds和pyds下你没看的文件,确保没有什么信息遗漏。

@hzhangxyz
hzhangxyz marked this pull request as ready for review November 24, 2025 23:23
Copilot AI and others added 2 commits November 24, 2025 23:26
…tecture

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Nov 24, 2025

Copy link
Copy Markdown
Contributor Author

挺好,但是

  1. 不要强调自动证明,这个太强了
  2. 你需要注意python和ts都是基于cxx的,我希望你能体现出来...

Addressed in 8d6cd4b:

  1. Removed "automated theorem proving" terminology - now uses "logical inference" and "iterative inference"
  2. Added new "Architecture" section showing C++ as the core with Python/TypeScript as bindings. Also updated installation sections to clarify the binding relationship (pybind11 for Python, Emscripten/WebAssembly for TypeScript)
  3. Reviewed all remaining files in include/ds/ and pyds/ - no additional information was missing

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.给个match的例子,你好像没有提供这个例子,在tsds/tsds.mts的注释里有
2.你给的整体的例子中,js和python是不需要set buffer的,只有在search之外会用到set buffer的大小
3.你给的前提不够推出结论,也就是说,你给的整体的例子是不可以运行的,无论是py/ts还是cxx,你把example里的情况照搬过来,需要有mp这个rule和一阶逻辑的三个schema axiom以及非非X,则可以推出X

…er_size, add match example

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Nov 24, 2025

Copy link
Copy Markdown
Contributor Author

1.给个match的例子,你好像没有提供这个例子,在tsds/tsds.mts的注释里有
2.你给的整体的例子中,js和python是不需要set buffer的,只有在search之外会用到set bu...

Addressed in a1a2151:

  1. Added match example in Core Concepts section showing modus ponens with double negation elimination axiom
  2. Removed buffer_size calls from JS and Python examples
  3. Fixed all examples with complete axioms: modus ponens rule + all 3 schema axioms + !!X premise, with proper while loop to execute until target is found

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

请给cxx的example加上检查target找到后的输出和终止,详情见example里的做法。

其他都很好,不用修改了。

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Nov 24, 2025

Copy link
Copy Markdown
Contributor Author

请给cxx的example加上检查target找到后的输出和终止,详情见example里的做法。

其他都很好,不用修改了。

Addressed in 5c4ffed: Added target checking and termination to the C++ example, using text_to_rule, memcmp comparison, and while loop pattern from the examples directory.

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

缺个cstdio,补上

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Nov 25, 2025

Copy link
Copy Markdown
Contributor Author

缺个cstdio,补上

Added in f90b44d.

@hzhangxyz
hzhangxyz merged commit ca17492 into main Nov 25, 2025
58 of 64 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add readme.md

2 participants