https://github.com/tani/cl-todolist-app
Todolist app written in Common Lisp and Nix
https://github.com/tani/cl-todolist-app
Last synced: 4 months ago
JSON representation
Todolist app written in Common Lisp and Nix
- Host: GitHub
- URL: https://github.com/tani/cl-todolist-app
- Owner: tani
- Created: 2024-11-02T21:33:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-02T21:54:19.000Z (8 months ago)
- Last Synced: 2025-01-11T11:46:59.010Z (5 months ago)
- Language: Nix
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Todo List written in Common Lisp
This repository contains a common lisp project for a simple todo list.
## Usage
### Run entrypoint
The entrypoint of this project is `main` function.
You can run it with the following command:
```sh
nix run .#main-sbcl
```
- `.#main-sbcl`: Run the entrypoint using SBCL.
- `.#main-ecl`: Run the entrypoint using ECL.
### Run tests
The tests of this project are located in the `test` directory.
You can run them with the following command:
```sh
nix run .#test-sbcl
```
We use [Parachute](https://github.com/Shinmera/parachute) for testing.
Thanks to [Shinmera](https://github.com/Shinmera) for this great library.
- `.#test-sbcl`: Run all tests using SBCL.
- `.#test-ecl`: Run all tests using ECL.
### Run REPL
You can run a REPL with the following command:
```sh
nix develop -c sbcl # ecl or abcl
```
To load the project, you can use the following code:
```lisp
(require :uiop)
(load (uiop:getenv "ASDF"))
(require :todolist)
```
## License
This projects is licensed under the following license:
>
> MIT No Attribution
>
> Copyright 2024 Masaya Taniguchi
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this
> software and associated documentation files (the "Software"), to deal in the Software
> without restriction, including without limitation the rights to use, copy, modify,
> merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
> permit persons to whom the Software is furnished to do so.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
> INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
> PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.