search

writefreely / documentation

WriteFreely documentation
https://writefreely.org/docs
Other
17 stars 12 forks source link

Developer documentation is off/outdated? #42

Closed realkinetix closed 7 months ago

realkinetix commented 1 year ago

The developer quick start would be great, but...

go get -d github.com/writefreely/writefreely/cmd/writefreely go: go.mod file not found in current directory or any parent directory. 'go get' is no longer supported outside a module. To build and install a command, use 'go install' with a version, like 'go install example.com/cmd@latest' For more information, see https://golang.org/doc/go-get-install-deprecation or run 'go help get' or 'go help install'. go version go1.19.2 linux/amd64

Even if the first step was to work, what is $GOPATH expected to be?

`write@ded1 ~ $ echo $GOPATH

write@ded1 ~ $`

Even in the detail steps:

`go get -u github.com/jteeuwen/go-bindata/go-bindata go-bindata -pkg writefreely -ignore=\.gitignore schema.sql sqlite.sql

The first step doesn't seem to put go-bindata in an expected path... were you expecting a system-wide install?

If I use a system-wide go-bindata, then things seem OK until this section:

cd less export CSSDIR=../static/css/ lessc app.less --clean-css="--s1 --advanced" $(CSSDIR)write.css lessc fonts.less --clean-css="--s1 --advanced" $(CSSDIR)fonts.css lessc icons.less --clean-css="--s1 --advanced" $(CSSDIR)icons.css`

../node_modules/less/bin/lessc app.less --clean-css="--s1 --advanced" $(CSSDIR)write.css -bash: CSSDIR: command not found Unable to load plugin clean-css please make sure that it is installed under or at the same level as less

Sorry, what shell are we using? ${CSSDIR} is what bash needs, no?

But... ../node_modules/less/bin/lessc app.less --clean-css="--s1 --advanced" ${CSSDIR}write.css Unable to load plugin clean-css please make sure that it is installed under or at the same level as less

Stuck here, since lessc installed via the recommended npm command seems to be missing stuff.

Both paths seem to fail in a bash user-level setup.

donfeduardo commented 11 months ago

The developer documentation tagged with the current release 0.14.0 still references go-bindata even though that was changed in https://github.com/writefreely/writefreely/pull/610

thebaer commented 7 months ago

Thanks for bringing this up -- I have updated docs in #52, which I'll merge soon.