rewrite README
This commit is contained in:
41
README.md
41
README.md
@@ -1,11 +1,13 @@
|
||||
# Fes
|
||||
|
||||
A lightweight, static, and opinionated microframework.
|
||||
Fes is an embedded Lua microwebframework for create static, extensible
|
||||
websites. Using file-based routes you can easily strucutre you website just by
|
||||
moving files around. See [fsdproject.org](https://fsdproject.org) for a
|
||||
real-world example.
|
||||
|
||||
## Usage
|
||||
|
||||
This is the `fes new <project>` output
|
||||
## A Simple Example
|
||||
```lua
|
||||
# project/www/index.lua as created from fes new project
|
||||
local fes = require("fes")
|
||||
local site = fes.fes()
|
||||
|
||||
@@ -14,32 +16,9 @@ site:h1("Hello, World!")
|
||||
return site
|
||||
```
|
||||
|
||||
This can be ran with `fes run <project>` where `<project>` is the location of the website.
|
||||
|
||||
## Examples
|
||||
|
||||
See `examples/` for different features, `canonical/` contains the best practices for this microframework.
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
git clone https://git.vxserver.dev/fSD/fes.git
|
||||
cd fes
|
||||
|
||||
go build .
|
||||
./fes run examples/hello-world # if this works install
|
||||
|
||||
go install fes
|
||||
```
|
||||
fes run project
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Run `fes doc` for the documentation website or goto [docs.vxserver.dev](https://docs.vxserver.dev)
|
||||
|
||||
## License
|
||||
|
||||
ISC License
|
||||
|
||||
Copyright (C) 2025-2026 fSD
|
||||
|
||||
See `COPYING`
|
||||
## Contributing
|
||||
See [fSD hacking](https://fsdproject.org/hacking) and [fSD community](https://fsdproject.org/community)
|
||||
|
||||
Reference in New Issue
Block a user