Added docs
This commit is contained in:
45
README.md
Normal file
45
README.md
Normal file
@ -0,0 +1,45 @@
|
||||
|
||||
# <p align="center">Flair</p>
|
||||
|
||||
An extra simplified version of Flask, written as a Rust lib.
|
||||
## 🧐 Features
|
||||
- Reads templates
|
||||
- Dynamically generate content based on rust variables or bash commands
|
||||
|
||||
# Templates ?
|
||||
|
||||
Templates are defined as .ft files.
|
||||
|
||||
They may contain any text. Special words are defined between percentage signs:
|
||||
```
|
||||
Hello %%name%%
|
||||
```
|
||||
|
||||
## Try
|
||||
An example website is included.
|
||||
|
||||
To see it, clone this repo, then:
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
Next, go to http://localhost:8080
|
||||
|
||||
## Use
|
||||
Add this to your Cargo.toml
|
||||
```bash
|
||||
flair = { git = "https://gitea.squi.fr/Rust/flair.git" }
|
||||
```
|
||||
|
||||
## Doc
|
||||
Clone this repo, then compile and open the doc:
|
||||
```bash
|
||||
cargo doc --open
|
||||
```
|
||||
|
||||
## 🙇 Author
|
||||
Justine Pelletreau
|
||||
|
||||
|
||||
## ➤ License
|
||||
Distributed as is.
|
||||
Reference in New Issue
Block a user