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

Full installation instructions for Linux #26

Closed
faultyserver opened this issue Nov 5, 2017 · 0 comments · Fixed by #32
Closed

Full installation instructions for Linux #26

faultyserver opened this issue Nov 5, 2017 · 0 comments · Fixed by #32
Labels
docs.guides An issue relating to any official guides for Myst docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag good first issue An issue that provides a good intro to working with the Myst codebase. Be helpful! rfc A request for comments from the community
Milestone

Comments

@faultyserver
Copy link
Member

The instructions are mostly complete, but not that great, and still leave a lot of the exact details for the reader to figure out. It'd be a lot better to have complete, exact instructions for installation.

Here are the steps that I ran to install v0.1.0 on an Ubuntu system:

# Pull a stable source
wget https://github.com/myst-lang/myst/archive/v0.1.0.tar.gz
# Extract it
tar xvf v0.1.0.tar.gz
cd myst-0.1.0
# Build the executable
shards build
# Link it to somewhere in $PATH
sudo ln -s /path/to/bin/myst /usr/local/bin/myst
# Run a test file
echo "[1,2,3].each{ |e| IO.puts(e) }" > test.mt
myst test.mt

Some notes on what should be expanded:

  • Explain what sources are available for download. (Link to the latest release. Maybe also the current master source?)
  • Explain various linking strategies (ln -s to /local/bin, or add the directory to $PATH)
  • Explain that stdlib needs to be available one directory up from the executable.
@faultyserver faultyserver added docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag docs.guides An issue relating to any official guides for Myst good first issue An issue that provides a good intro to working with the Myst codebase. Be helpful! rfc A request for comments from the community labels Nov 5, 2017
@faultyserver faultyserver added this to the Next milestone Nov 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs.guides An issue relating to any official guides for Myst docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag good first issue An issue that provides a good intro to working with the Myst codebase. Be helpful! rfc A request for comments from the community
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant