Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inigo init - misleading README #39

Open
JankaGramofonomanka opened this issue Nov 26, 2021 · 3 comments
Open

inigo init - misleading README #39

JankaGramofonomanka opened this issue Nov 26, 2021 · 3 comments

Comments

@JankaGramofonomanka
Copy link

When I try to initialize a project (using the exact commands as in README)

$ mkdir MyApp && cd MyApp
$ inigo init MyNamespace MyApp

I get this:

usage: Inigo <command> <...args>

	archive <pkg_file> <out_file>: Archive a given package
	build <code-gen=node>: Build program under given code gen
	build-deps: Build all deps
	clean <deps?>: Clean package artifacts, optionally including deps
	check: Typecheck the project
	exec <code-gen=node> -- ...args: Execute program with given args
	extract <archive_file> <out_path>: Extract a given archive to directory
	fetch-deps <server>: Fetch and build all deps (opts: --no-build, --dev)
	init <namespace> <package> <template.inigo>: Initialize a new project with given namespace and package name
	login <server>: Login to an account
	pull <server> <package_ns> <package_name> <version?>: Pull a package from remote
	push <server> <pkg_file>: Push a package to remote
	register <server>: Register an account namespace
	repl: Launch idris2 repl
	test: Run tests via IdrTest

@JankaGramofonomanka
Copy link
Author

Ok, so now that I actually looked at the usage info, I realised, that I should add a template like this:

$ inigo init MyNamespace MyApp <template.inigo>

But still, the README is misleading, and it is not obvious how to obtain a template.

@JankaGramofonomanka JankaGramofonomanka changed the title Inigo prints the usage of inigo, instead of initializing a project inigo init - misleading README Nov 30, 2021
@Z-snails
Copy link

When I added templates I forgot to update the README. There are 2 example templates in the templates subdirectory. I think I added some docs on templates but they aren't hosted anywhere so you'll have to build them yourself.

@JankaGramofonomanka
Copy link
Author

I found the templates but I can't build them. (Issue #40)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants