README.md

   1 # flow-web
   2
   3 `flow-web` is a program written in Rust that will allow you to generate
   4 [https://www.luflow.net](https://www.luflow.net) static website.
   5
   6 ## Installation
   7
   8 Install `Rust` from your package manager or by downloading from here:
   9 [https://rust-lang.org/](https://rust-lang.org/).
  10
  11 ## Generate the website
  12
  13 Build using release mode:
  14
  15 ```sh
  16 cargo build --release
  17 ```
  18
  19 Run to generate site:
  20
  21 ```sh
  22 cargo run --release
  23 ```
  24
  25 The generated output can be found in the '**output**' folder.
  26
  27 ## Serve locally
  28
  29 Run the following command to serve locally using **servez** as an example:
  30
  31 ```sh
  32 servez output
  33 ```
  34
  35 Then, visit the following url in a web browser:
  36
  37 [http://localhost:8080/](http://localhost:8080)
  38
  39 You can stop the server pressing CTRL+c.
  40
  41 ## LICENSE
  42
  43 See the file 'LICENSE' for license information.