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.

Sign up for GitHub

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

Jump to bottom

Mention development environment prerequisites in DG #965

Merged
merged 3 commits into from
Jan 15, 2020
Merged

Mention development environment prerequisites in DG #965

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa3909f
Update developer guide to include information on dependencies needed …
le0tan Dec 27, 2019
2703ac9
Make requested changes to the developer guide.
le0tan Dec 29, 2019
f0fbb4a
Make requested changes to devGuide
le0tan Jan 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/devGuide/devGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,19 @@ We expect contributors for MarkBind to have basic knowledge of the following:
* Markdown
* Command-line environment

*Optional*: MarkBind also supports inline pUML, to make use of this integration, you need:
le0tan marked this conversation as resolved.
Show resolved Hide resolved

* Java 8 or later (required to run the PlantUML JAR executable)
* Graphviz v2.38 or later (required to generate all diagrams)

Before cloning MarkBind's repo, run

* `node --version`
* `npm --version`
* (Optional for pUML integration) `java --version`, `dot -V`

to make sure that you have all necessary dependencies available.

## Environment

The MarkBind project should be developed with Node.js version 8.0 or higher.
Expand Down