readme.md needs more information

[oddlittlebird]

There is not currently enough information for a new user to be successful.

What do they do after they download the repo and start the Hugo server?

I suggest adding enough for a "Hello, World!" type output in index.md. I tried editing index.md, suddenly everything between the +++ lines is showing up on my page.

Also, adding some basic layouts or at least giving some links for where to get layouts would be helpful. I assumed the theme would give me layouts to match your demo site, but apparently it does not. Very confusing and frustrating.

[oddlittlebird]

Update: The text showing was actually from my Markdown editor in localhost:8090. http://localhost:1313/ is showing only a blank page, with no updated text or styling or anything.

Good news, your instructions work up to that point, because according to the command prompt, the Hugo server is running.

As a user, I need to know what to do next, and what should happen next.

[stp-ip]

Thanks for taking the time to provide feedback really appreciated. Hope we can improve this.

[pv2b]

I'm also got stuck here.

Telling me to type in "index.md" is not super helpful since there are multiple index.md files in multiple directories, and it's not obvious how adding text is supposed to work.

I tried adding text between the +++ sections of content/_index/index.md, but that just causes hugo to barf because it's expecting some kind of key-value pairs there. Adding it after the +++ seems to do nothing at all.

[GaProgMan]

I have found that when running the syna-starter using hugo serve -D (as mentioned in the readme), I get a lot of warnings:

Building sites … WARN 2020/01/20 10:51:45 found no layout file for "HTML" for "page": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:45 found no layout file for "HTML" for "page": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:45 found no layout file for "HTML" for "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:45 found no layout file for "HTML" for "taxonomyTerm": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:45 found no layout file for "HTML" for "taxonomyTerm": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:45 found no layout file for "JSON" for "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.

                   | EN  
+------------------+----+
  Pages            |  9  
  Paginator pages  |  0  
  Non-page files   |  0  
  Static files     |  2  
  Processed images |  0  
  Aliases          |  0  
  Sitemaps         |  1  
  Cleaned          |  0  

Total in 17 ms
Watching for changes in /Code/syna-starter/{content,layouts,static}
Watching for config changes in //Code/syna-starter/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at //localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
WARN 2020/01/20 10:51:47 found no layout file for "HTML" for "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:47 found no layout file for "HTML" for "page": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2020/01/20 10:51:47 found no layout file for "JSON" for "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.

My guess is either I'm running a version of Hugo which is incompatible (Hugo Static Site Generator v0.57.2/extended linux/amd64 BuildDate: 2019-08-18T05:29:32Z) or that there are files missing from the starter's Master branch which are required in order to use it.

[stp-ip]

The minimum version currently is v0.61.

Could you check with v0.61 or higher. Current Hugo version is v0.62.2.

[stp-ip]

Back to the original issue.

@oddlittlebird did you get setup with Syna in the end? Did you look at our docs page: https://syna.okkur.org/docs. There you have the various fragments and code snippets of them. The starter structure was intentionally minimal to not overwhelm the user.

Happy for more suggestions on an improved Readme.

[mpourismaiel]

@GaProgMan Please create a new issue since it's unrelated to the this one. Also it seems like your themes/ directory is empty. Have you run git submodule commands? Also please upgrade your Hugo to v0.61 as that's our minimum supported version as @stp-ip mentioned.

[GaProgMan]

Apologies for confusing what I saw with the actual issue.

I have upgraded my Hugo install to vLatest (0.62.2 as of writing this comment) and the site builds.

[mpourismaiel]

@GaProgMan Happy to hear that. Let us know if you run into any other issues. We'll be happy to help.