doc: update README

This commit is contained in:
Julien Oculi 2024-06-06 16:26:03 +02:00
parent 68b758e9af
commit 7f094710da

View file

@ -1,16 +1,51 @@
# Fresh project
<div align="center">
<img src="./static/assets/icon-512-rounded.png" alt="logo" width="150px" height="150px"/>
<h1>Coh@bit.fr</h1>
<p>Site web de cohabit</p>
</div>
Your new Fresh project is ready to go. You can follow the Fresh "Getting
Started" guide here: https://fresh.deno.dev/docs/getting-started
[![project doc](https://img.shields.io/badge/project-doc-blue?style=flat-square)]()
### Usage
## 👀 Vue d'ensemble du projet
Make sure to install Deno: https://deno.land/manual/getting_started/installation
TODO
Then start the project:
## 💭 Choix et design
```
deno task start
TODO
## 🗂️ Structure
TODO
## ⚙️ Fonctionnement
TODO
## ▶️ Usage
TODO
```sh
deno task start # Local watch mode
deno task build && deno task serve # Production run
```
This will watch the project directory and restart as necessary.
## 🤝 Contributing
Any kind of contribution is welcomed. Please read
[contributing guidelines](./CONTRIBUTING.md) before and respect
[contributor covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
### For local development:
**Required dependencies**:
- [`deno`](https://deno.land) To run project (code, ci, ...).
**Using VSCode**:
- Pre-configured workspace available in
[`gowest.code-workspace`](./gowest.code-workspace).
- Or without local tooling install use [`.devcontainer`](./.devcontainer).