Skip to content

Commit

Permalink
docs: 📝 更新完善文档
Browse files Browse the repository at this point in the history
自述文件的English版本(WIP);完善Cargo.toml的库信息
  • Loading branch information
ARCJ137442 committed Apr 3, 2024
1 parent 34f2a5e commit 98b6283
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 43 deletions.
10 changes: 10 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
name = "babel_nar"
version = "0.13.1"
edition = "2021"
description = """
Implementation and application supports of the NAVM model
"""

readme = "README.md"
keywords = ["NARS", "NAVM"]

license = "MIT OR Apache-2.0"
categories = [] # TODO
repository = "https://github.com/ARCJ137442/BabelNAR.rs"

# Cargo文档参考:<https://rustwiki.org/zh-CN/cargo/reference/manifest.html>

Expand Down
47 changes: 4 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,9 @@
# BabelNAR.rs

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

该项目使用[语义化版本 2.0.0](https://semver.org/)进行版本号管理。

[**NAVM.rs**](https://github.com/ARCJ137442/NAVM.rs)[CIN](#cin-computer-implement-of-nars)**启动器****运行时**及应用程序实现

- 前身为[**BabelNAR.jl**](https://github.com/ARCJ137442/BabelNAR.jl)
- ✨为「非公理虚拟机模型」提供程序实现
- ✨统一各[CIN](#cin-computer-implement-of-nars)**输入输出**形式,聚合使用各大NARS实现

## 概念

### CIN (Computer Implement of NARS)

- 「NARS计算机实现」之英文缩写
- 指代所有**实现NARS**的计算机软件系统
- 不要求完整实现NAL 1~9
English | [简体中文](README.zh-cn.md)

### ***CommonNarsese***

🔗参考[**NAVM.jl**的对应部分](https://github.com/ARCJ137442/navm.jl?tab=readme-ov-file#commonnarsese)

## 各CIN对接情况

🕒最后更新时间:【2024-03-26 01:43:28】

| CIN | 实现方法 | 进程安全 | 输入转译 | 输出转译 |
| :---------- | :---------: | :--: | :--: | :--: |
| OpenNARS | `java -jar` ||| 🚧 |
| ONA | 直接启动exe ||| 🚧 |
| PyNARS | `python -m` || 🚧 | 🚧 |
| NARS-Python | 直接启动exe ||||
| OpenJunars | `julia` ||||

注:

- 🚧输入输出转译功能仍然在从[BabelNAR_Implements](https://github.com/ARCJ137442/BabelNAR_Implements.jl)迁移
- ❓NARS-Python的exe界面可能会在终止后延时关闭
- ❌基于`julia`启动OpenJunars脚本`launch.jl`时,对「输出捕获」尚未有成功记录
- ❌目前对NARS-Python的「输出捕获」尚未有成功记录
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

## 参考
Implementation and application supports of the NAVM model

- [BabelNAR](https://github.com/ARCJ137442/BabelNAR.jl)
- [BabelNAR_Implements](https://github.com/ARCJ137442/BabelNAR_Implements.jl)
- [NAVM.rs](https://github.com/ARCJ137442/NAVM.rs)
⚠️【2024-04-03 15:12:55】**This documentation is still in progress. For full and latest content, please refer to [the Simplified Chinese version](README.zh-cn.md).**
50 changes: 50 additions & 0 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# BabelNAR.rs

[English](README.md) | 简体中文

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

该项目使用[语义化版本 2.0.0](https://semver.org/)进行版本号管理。

[**NAVM.rs**](https://github.com/ARCJ137442/NAVM.rs)[CIN](#cin-computer-implement-of-nars)**启动器****运行时**及应用程序实现

- 前身为[**BabelNAR.jl**](https://github.com/ARCJ137442/BabelNAR.jl)
- ✨为「非公理虚拟机模型」提供程序实现
- ✨统一各[CIN](#cin-computer-implement-of-nars)**输入输出**形式,聚合使用各大NARS实现

## 概念

### CIN (Computer Implement of NARS)

- 「NARS计算机实现」之英文缩写
- 指代所有**实现NARS**的计算机软件系统
- 不要求完整实现NAL 1~9

### ***CommonNarsese***

🔗参考[**NAVM.jl**的对应部分](https://github.com/ARCJ137442/navm.jl?tab=readme-ov-file#commonnarsese)

## 各CIN对接情况

🕒最后更新时间:【2024-03-26 01:43:28】

| CIN | 实现方法 | 进程安全 | 输入转译 | 输出转译 |
| :---------- | :---------: | :--: | :--: | :--: |
| OpenNARS | `java -jar` ||| 🚧 |
| ONA | 直接启动exe ||| 🚧 |
| PyNARS | `python -m` || 🚧 | 🚧 |
| NARS-Python | 直接启动exe ||||
| OpenJunars | `julia` ||||

注:

- 🚧输入输出转译功能仍然在从[BabelNAR_Implements](https://github.com/ARCJ137442/BabelNAR_Implements.jl)迁移
- ❓NARS-Python的exe界面可能会在终止后延时关闭
- ❌基于`julia`启动OpenJunars脚本`launch.jl`时,对「输出捕获」尚未有成功记录
- ❌目前对NARS-Python的「输出捕获」尚未有成功记录

## 参考

- [BabelNAR](https://github.com/ARCJ137442/BabelNAR.jl)
- [BabelNAR_Implements](https://github.com/ARCJ137442/BabelNAR_Implements.jl)
- [NAVM.rs](https://github.com/ARCJ137442/NAVM.rs)

0 comments on commit 98b6283

Please sign in to comment.