mirror of
https://github.com/LucasVbr/croissant.git
synced 2026-05-13 17:12:10 +00:00
Setup dune project
This commit is contained in:
+10
@@ -0,0 +1,10 @@
|
|||||||
|
# IDE folders
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
.fleet/
|
||||||
|
|
||||||
|
# Build folder
|
||||||
|
_build/
|
||||||
|
|
||||||
|
# Mac OS
|
||||||
|
.DS_Store
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
<h1 align="center">Welcome to Croissant 👋</h1>
|
||||||
|
<p>
|
||||||
|
<img alt="Version" src="https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000" />
|
||||||
|
<a href="./LICENCE" target="_blank">
|
||||||
|
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
> Custom programming language in french
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
This project uses [Dune](https://dune.build/) as a build system. You can install it with the following command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
opam install dune
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Run the following commands to build and run the project:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
dune build
|
||||||
|
dune exec croissant
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run tests
|
||||||
|
|
||||||
|
```sh
|
||||||
|
dune test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Author(s) 👤
|
||||||
|
|
||||||
|
- **[@LucasVbr](https://github.com/LucasVbr)**
|
||||||
|
|
||||||
|
## Show your support
|
||||||
|
|
||||||
|
Give a ⭐️ if this project helped you!
|
||||||
|
|
||||||
|
## 📝 License
|
||||||
|
|
||||||
|
Copyright © 2024 [LucasVbr](https://github.com/LucasVbr).<br />
|
||||||
|
This project is [MIT](LICENCE) licensed.
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
(executable
|
||||||
|
(public_name croissant)
|
||||||
|
(name main)
|
||||||
|
(libraries croissant))
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
let () = print_endline "Hello, World!"
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
(lang dune 3.10)
|
||||||
|
|
||||||
|
(name croissant)
|
||||||
|
|
||||||
|
(generate_opam_files true)
|
||||||
|
|
||||||
|
(source
|
||||||
|
(github username/reponame))
|
||||||
|
|
||||||
|
(authors "Author Name")
|
||||||
|
|
||||||
|
(maintainers "Maintainer Name")
|
||||||
|
|
||||||
|
(license LICENSE)
|
||||||
|
|
||||||
|
(documentation https://url/to/documentation)
|
||||||
|
|
||||||
|
(package
|
||||||
|
(name croissant)
|
||||||
|
(synopsis "A short synopsis")
|
||||||
|
(description "A longer description")
|
||||||
|
(depends ocaml dune)
|
||||||
|
(tags
|
||||||
|
(topics "to describe" your project)))
|
||||||
|
|
||||||
|
; See the complete stanza docs at https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
|
||||||
Reference in New Issue
Block a user