README.exe 是的，你没看错，是EXE

让你的README变成可执行文档，再也不用编写无用的文档，再也不必操心环境问题。

2022.05.10

作为开发者，拿到一个新的代码库的时候一般都会先去看README文件，通过这个文件可以知道这套代码所需要安装的环境，工具和操作方式。这件事情本来应该是一件很愉悦的事情，因为每一套新代码其实都是开发者的新玩具，拿到新玩具的心情那肯定是不错的。但是，当你阅读玩具说明书之后，发现这份说明书完全不配套的时候，那心里一定是一万匹草泥马在奔腾。当然，这也很容易理解，开发者不爱写文档，特别是那些没有用的文档。至少，README对写的人来说其实没啥用，因为写的人都已经清楚了文档中的内容，至于看的人感受如何，那就呵呵吧。

这个问题的根源在于README只能看，不能运行！如果我们能够让README活起来，从 README.md 变成 README.exe，那是不是就可以解决这个问题了呢？答案是肯定的！因为写的人自己也可以用这份文档来启动项目。这样，写文档的人有了动力，看（运行）文档的人也会很爽。

这就是SmartIDE的核心功能: IDE as Code能力。

神奇的IDE配置文件

SmartIDE最初始的设计灵感就是如何能够让README活起来？为了做到这一点，我们设计了一个 IDE配置文件 (默认文件名 .ide.yaml）文件格式。这个文件中完整描述了运行当前代码所需要的环境配置，包括 基础环境SDK，应用服务器，应用端口，配置文件，网络依赖以及所使用的IDE工具。有了这个文件，开发者就可以真正实现一键启动开发调试，而不会再听到：“在我这里工作呀，是你的环境问题！” 这种骇人听闻的抱怨。

有了这个文件，任何人都可以使用一个简单的指令来一键搭建一模一样的开发环境，指令如下：

Copy

smartide start https://github.com/idcf-boat-house/boatho