fSD/fes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rewrite README

Browse Source
This commit is contained in:
vx-clutch
2026-01-20 13:00:55 -05:00
parent 383ba0d831
commit fedb515df1
1 changed files with 10 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -1,11 +1,13 @@
# Fes # 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 ## A Simple Example
This is the `fes new <project>` output
```lua ```lua
# project/www/index.lua as created from fes new project
local fes = require("fes") local fes = require("fes")
local site = fes.fes() local site = fes.fes()
@@ -14,32 +16,9 @@ site:h1("Hello, World!")
return site return site
``` ```
This can be ran with `fes run <project>` where `<project>` is the location of the website. ```
fes run project
## 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
``` ```
## Documentation ## Contributing
See [fSD hacking](https://fsdproject.org/hacking) and [fSD community](https://fsdproject.org/community)
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`