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

Improve Getting Started and Usability #48

Open
jcmartin opened this issue Aug 5, 2019 · 0 comments
Open

Improve Getting Started and Usability #48

jcmartin opened this issue Aug 5, 2019 · 0 comments

Comments

@jcmartin
Copy link

jcmartin commented Aug 5, 2019

Right now, there is no way to quickly get started using the compiler. One must go to the main website download the distribution AND also go to Documentation to discover how to install and use the stanza binary.

Ideally, one should only need to download the distribution to get started. Proposals for improving usability:

  1. Include either in the README or create a new file called INSTALL in the base directory that repeats the installation instructions found here: http://lbstanza.org/chapter1.html
  2. Simplify the distribution process. Don't require the user to specify what platform he is on. Easiest thing to do would be to include an install script per distribution that has the variable set according to which distribution it is.
  3. Support for -h and --help as arguments to the stanza binary that lists all available commands and flags. Right now everything that the compiler supports is not listed in one place. Often the first place one looks is through the binary, followed by the man page or the internet.
  4. A better help command. help without arguments would be equivalent to -h and --help. help may also take an argument that is a command, and it will describe the command and list the available flags/options.
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

1 participant