update README with build and run
This commit is contained in:
parent
5cc55a79ff
commit
7eb3bf0b44
29
README.md
29
README.md
|
@ -6,3 +6,32 @@ A simple web server for blogs generated from Markdown files.
|
|||
|
||||
**_This project is not yet stable. Expect frequent breaking changes! Only use this if you are willing to regularly adjust your project accordingly._**
|
||||
|
||||
|
||||
|
||||
## Build
|
||||
|
||||
```
|
||||
CGO_ENABLED=1 go build -o owl ./cmd/owl
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
To run the web server use the command:
|
||||
|
||||
```
|
||||
owl web
|
||||
```
|
||||
|
||||
The blog will run on port 3000 (http://localhost:3000)
|
||||
|
||||
To create a new account:
|
||||
|
||||
```
|
||||
owl new-author -u <name> -p <password>
|
||||
```
|
||||
|
||||
To retrieve a list of all commands run:
|
||||
|
||||
```
|
||||
owl -h
|
||||
```
|
Loading…
Reference in New Issue