search

glaciers-in-archives / snowman

A static site generator for SPARQL backends.
GNU Lesser General Public License v3.0
112 stars 11 forks source link

Install and usage instructions not completely clear #48

Closed hernanmd closed 2 years ago

hernanmd commented 2 years ago

After I download a stable release linked from the README as Download the latest release for your OS/architecture it does not mention anywhere that the file is actually the snowman executable, i.e.:

❯ file snowman-darwin-amd64
snowman-darwin-amd64: Mach-O 64-bit executable x86_64

However it works, but following instructions in the README, "Run snowman build to generate the site." produces the following output:

❯ ./snowman-darwin-amd64 build
Error: Unable to locate snowman.yaml in the current working directory. Error: stat snowman.yaml: no such file or directory

I wonder now what I should exactly download to get the snowman.yaml file. Should I clone the repository anyway?

Abbe98 commented 2 years ago

Thank you for the feedback, it looks like the readme could need some reordering. Snowman itself is just an executable, other files are a part of your project.

You can create a snowman.yaml file by bootstrapping a new project with the snowman new command, by downloading an example, or by creating one manually.

hernanmd commented 2 years ago

Thank you @Abbe98 I'm experimenting with the tool now.