CL-Project 使用教程
cl-projectGenerate modern project skeletons项目地址:https://gitcode.com/gh_mirrors/cl/cl-project
1. 项目的目录结构及介绍
CL-Project 是一个用于生成现代 Common Lisp 项目骨架的工具。以下是生成的项目目录结构及其介绍:
cl-sample/
├── src/
│ └── main.lisp
├── tests/
│ └── main.lisp
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── cl-project-test.asd
└── cl-project.asd
src/
: 存放项目源代码的目录。tests/
: 存放项目测试代码的目录。main.lisp
: 项目的主文件,通常包含项目的入口点。.gitignore
: 用于指定 Git 版本控制系统忽略的文件和目录。.travis.yml
: Travis CI 的配置文件,用于持续集成。LICENSE
: 项目的许可证文件。README.md
: 项目的说明文档。cl-project-test.asd
: 项目测试系统的定义文件。cl-project.asd
: 项目系统的定义文件。
2. 项目的启动文件介绍
项目的启动文件通常位于 src/
目录下,例如 main.lisp
。以下是一个典型的启动文件内容:
(defpackage :cl-sample
(:use :cl)
(:export :main))
(in-package :cl-sample)
(defun main ()
(format t "Hello, World!~%"))
defpackage
: 定义一个新的包cl-sample
,并指定使用cl
包。in-package
: 切换到cl-sample
包。defun main
: 定义一个名为main
的函数,作为项目的入口点。
3. 项目的配置文件介绍
项目的配置文件主要包括 .travis.yml
和 cl-project.asd
。
.travis.yml
.travis.yml
文件用于配置 Travis CI 的持续集成任务:
language: common-lisp
sudo: false
cache:
directories:
- $HOME/.roswell
before_install:
- curl -L https://raw.githubusercontent.com/roswell/roswell/release/scripts/install-for-ci.sh | sh
- ros install cl-project
script:
- ros -s cl-sample -e '(cl-sample:main)'
language
: 指定项目使用的语言为 Common Lisp。cache
: 指定缓存的目录。before_install
: 在安装前执行的命令,用于安装 Roswell 和 CL-Project。script
: 执行的测试脚本,调用项目的main
函数。
cl-project.asd
cl-project.asd
文件定义了项目的系统:
(asdf:defsystem #:cl-sample
:description "A sample Common Lisp project"
:author "Eitaro Fukamachi"
:license "MIT"
:depends-on (#:cl-project)
:components ((:file "src/main")))
asdf:defsystem
: 定义一个名为cl-sample
的系统。description
: 项目的描述。author
: 项目的作者。license
: 项目的许可证。depends-on
: 项目依赖的其他系统。components
: 项目的组件,指定源文件的位置。
以上是 CL-Project 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 CL-Project。
cl-projectGenerate modern project skeletons项目地址:https://gitcode.com/gh_mirrors/cl/cl-project