https://github.com/christopherbilg/crisp

(custom (rust) lisp)
https://github.com/christopherbilg/crisp

lisp rust

Last synced: about 1 month ago
JSON representation

(custom (rust) lisp)

• Host: GitHub
• URL: https://github.com/christopherbilg/crisp
• Owner: ChristopherBilg
• License: gpl-2.0
• Created: 2022-05-09T00:39:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-16T03:06:50.000Z (over 1 year ago)
• Last Synced: 2023-03-04T19:22:47.515Z (over 1 year ago)
• Topics: lisp, rust
• Language: Rust
• Homepage: https://chrisbilger.com/crisp/
• Size: 77 MB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Crisp

(custom (rust) lisp)

## Status

![ci-cd](https://github.com/ChristopherBilg/crisp/actions/workflows/ci-cd.yml/badge.svg)

![mdBook](https://github.com/ChristopherBilg/crisp/actions/workflows/gh-pages.yml/badge.svg)

![devskim](https://github.com/ChristopherBilg/crisp/actions/workflows/devskim.yml/badge.svg)

## Common Commands

- `cargo build`: Builds the Crisp binary

- `cargo run`: Runs the Crisp binary

- `cargo test`: Runs all test functions, in the ./tests directory, that contain the `#[test]` attribute

- `cargo doc [--open]`: Builds the automatically generated Crisp Rust documentation, and optionally opens it in a web browser

- `cargo fmt`: Standard formatter for Rust codestyle

- `cargo clippy [--fix]`: Standard linter for Rust, and optionally will automatically fix linted issues

- `mdbook build`: Builds the Crisp mdbook locally

- `mdbook serve [ | docs/]`: Serves the Crisp mdbook at http://localhost:3000, and rebuilds it on changes

## CI/CD Information

GitHub is the central CI/CD platform for the Crisp project. CI/CD will occur only when modifications are made (pull-requests) to the **master** branch.

## Additional Important Information

- [Code of Conduct Guidelines](./CODE_OF_CONDUCT.md)

- [Contributing Guidelines](./CONTRIBUTING.md)

- [Open Source License](./LICENSE.md)

- [Security (Vulnerability) Policy](./SECURITY.md)

- [Major Authors & Contributors](./AUTHORS.md)

- [Changelog (SemVer)](./CHANGELOG.md)

## Developers

If you would like to work on this project, please feel free to check the [issues](https://github.com/ChristopherBilg/crisp/issues) for a list of the current items that we need to be worked on. If you would like to work on any of them, please head to the [discussions](https://github.com/ChristopherBilg/crisp/discussions) area and a task can be marked for you.

### Documentation

Developers can find documentation for Crisp in the [docs/](./docs/) directory, or hosted online at [chrisbilger.com/crisp/](https://chrisbilger.com/crisp/).

The `cargo doc` documentation that is automatically generated by Cargo can be viewed by running `cargo doc --open`, or hosted online at [chrisbilger.com/crisp/doc/doc/crisp](https://chrisbilger.com/crisp/doc/doc/crisp).