INim 项目使用教程

INim 项目使用教程

INim Interactive Nim Shell / REPL / Playground 项目地址: https://gitcode.com/gh_mirrors/in/INim

1. 项目的目录结构及介绍

INim 项目是一个交互式 Nim 语言外壳（REPL），其目录结构如下：

INim/
├── .github/            # GitHub 工作流文件
│   └── workflows/
├── inimpkg/            # 包含 Nim 库文件
├── tests/              # 测试文件
├── .gitignore          # Git 忽略文件
├── LICENSE             # MIT 许可证文件
├── MAINTAINERS.md      # 项目维护者信息
├── README.md           # 项目说明文件
├── SECURITY.md         # 安全策略文件
├── inim.nim            # INim 主程序文件
├── inim.nimble         # Nimble 包配置文件
├── readme.gif          # 项目介绍 GIF 图片
└── setupci.sh          # CI 设置脚本

• .github/workflows/: 包含项目的持续集成和持续部署的 GitHub Actions 工作流文件。
• inimpkg/: 存放 Nim 语言相关的库和模块。
• tests/: 包含项目的单元测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的 MIT 许可证。
• MAINTAINERS.md: 介绍项目维护者的信息。
• README.md: 项目的基本介绍和用法。
• SECURITY.md: 项目安全策略和报告安全问题的指南。
• inim.nim: INim 项目的核心 Nim 代码文件。
• inim.nimble: Nimble 包的配置文件，用于管理 Nim 包的依赖和元数据。
• readme.gif: 项目的介绍动画 GIF。
• setupci.sh: 设置 CI 环境的脚本。

2. 项目的启动文件介绍

项目的启动文件是 inim.nim，这是 INim 的主程序文件。它包含了创建和运行 Nim 交互式外壳所需的所有 Nim 代码。你可以通过 Nim 编译器直接运行它：

nim c inim.nim

或者如果你已经将 INim 安装为 Nimble 包，可以使用 Nimble 来运行它：

nimble run inim

3. 项目的配置文件介绍

INim 项目支持通过配置文件进行个性化设置。配置文件可以通过以下命令创建：

inim --createRcFile

配置文件根据操作系统不同存放位置也不同：

• 在 Linux 和 macOS 上，配置文件存放在 ~/.config/inim/。
• 在 Windows 上，配置文件存放在 %APPDATA%\inim。

配置文件允许你更改以下默认设置：

• prompt: 设置命令提示符字符串（默认为 "inim> "）。
• showTypes: 打印变量时不使用 echo 也会显示类型（默认为 true）。
• showColor: 输出结果使用颜色（默认为 false）。
• history: 开启持久化历史记录（默认为 true）。
• withTools: 启用内置工具，如 cd(), ls(), pwd(), call()（默认为 false）。

INim Interactive Nim Shell / REPL / Playground 项目地址: https://gitcode.com/gh_mirrors/in/INim