Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
karlramberg committed Nov 18, 2023
1 parent ae24931 commit a9c05b9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,22 @@ if you are on Linux or macOS. Run as you would a normal comamnd in your terminal
executable permissions (Using `chmod +x` on Linux/macOS or the "Run as Administrator" function on Windows).

If neither file runs on your system, you can build a new one using Go. Install the Go langauge on your system from
https://go.dev/. Clone this repository and then run `go build websiteBuilder.go` in your terminal to make a new file
<https://go.dev/>. Clone this repository and then run `go build websiteBuilder.go` in your terminal to make a new file
for your system's architecture.

## CLI Usage
## Usage

```$ wb input_folder/ output_folder/ template.html```
To learn website builder, simply use the `-h` flag. Which prints...

```bash
Usage of wb:
-i string
Input folder of incomplete HTML pages (default "src")
-o string
Output folder to place complete HTML pages (default "docs")
-t string
Template HTML page to inject HTML into (default "template.html")
```

## Example website(s)

Expand Down
3 changes: 2 additions & 1 deletion website_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ func main() {
if err != nil && os.IsNotExist(err) {
fmt.Println("> Generating " + *oFlag + "...")
os.MkdirAll(*oFlag, 0755)

} else { // Clean-up the output folder
fmt.Println("> Cleaning " + *oFlag + "...")

Expand Down Expand Up @@ -107,5 +108,5 @@ func main() {
return nil
})

fmt.Println("> Site built successfully!")
fmt.Println("> Site built successfully! :)")
}

0 comments on commit a9c05b9

Please sign in to comment.