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

Could README instruction have more details? #55

Open
catcatcatcat opened this issue Jun 27, 2019 · 2 comments
Open

Could README instruction have more details? #55

catcatcatcat opened this issue Jun 27, 2019 · 2 comments

Comments

@catcatcatcat
Copy link

Dear Mermaid Team,

Thank you for the wonderful editor in advance, I love to use mermaid online editor.

My issue is a novice problem.

Sometimes I have no internet connection and cannot use it, in a previous issue #217
mermaid-js/mermaid#217
I saw one of the solutions is run it locally, but I failed in the very first step yarn install with an error msg: "-bash: yarn: command not found".

I am a non-programmer and have little knowledge about what's going on,
after I asked my friend, I tried: npm install yarn and run yarn install again with + [email protected] but still saw the same error msg.

Then I tried brew install yarn and finally succeeded with yarn install v1.17.0

I think it would be kind if README pointed out you have to install yarn before type yarn install and it would be kinder if add how to install yarn section.

How do you think about it? Thank you so much.

@morgen-peschke
Copy link

For anyone who stumbles on this issue, the project has been moved and the new one includes a docker image you can spin up locally to get an offline editor.

See: https://github.com/mermaid-js/mermaid-live-editor#run-published-image

@catcatcatcat
Copy link
Author

Thank you for replying!

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