Skip to content

Commit

Permalink
Merge pull request #38 from coolaj86/readme-for-noobs
Browse files Browse the repository at this point in the history
Readme for noobs
  • Loading branch information
UnnoTed authored Oct 20, 2018
2 parents 9e5329b + bc51cc8 commit a4c22f4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,27 @@ MIT

### Get Started

###### TL;DR QuickStart™

Here's the get-you-going in 30 seconds or less:

```bash
git clone https://github.com/UnnoTed/fileb0x.git
cd fileb0x
cd _example/simple
go generate
go build
./simple
```

* `mod.go` defines the package as `example.com/foo/simple`
* `b0x.yaml` defines the sub-package `static` from the folder `public`
* `main.go` includes the comment `//go:generate go run github.com/UnnoTed/fileb0x b0x.yaml`
* `main.go` also includes the import `example.com/foo/simple/static`
* `go generate` locally installs `fileb0x` which generates `./static` according to `bax.yaml`
* `go build` creates the binary `simple` from `package main` in the current folder
* `./simple` runs the self-contained standalone webserver with built-in files from `public`

<details>

<summary>How to use it?</summary>
Expand Down

0 comments on commit a4c22f4

Please sign in to comment.