This repository has been archived by the owner on Feb 1, 2019. It is now read-only.
Fix UML Diagram for README and Rust Docs. Setup Cargo Make task runner. Setup Cargo Watch. #47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… README and Rust Docs
jamesray1
reviewed
Apr 24, 2018
|
|
||
| [tasks.uml] | ||
| command = "open" | ||
| args = ["-a", "Google Chrome", "./diagrams/ml.svg"] |
There was a problem hiding this comment.
Why have Google Chrome here? I use Firefox.
There was a problem hiding this comment.
Good point. I'll add it as an issue
jamesray1
approved these changes
Apr 24, 2018
|
Looks good, I'll merge. |
AyushyaChitransh
pushed a commit
to AyushyaChitransh/diamond_drops
that referenced
this pull request
May 9, 2018
Fix UML Diagram for README and Rust Docs. Setup Cargo Make task runner. Setup Cargo Watch.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've fixed the UML diagram so that it generates correctly and is shown in the README file and in the Rust Docs. I've also integrated Cargo Make, which is awesome, as you just configure a default Makefile.toml for all your tasks, with much simpler usage. For example, to run all the implementations at once (i.e. proposer mode, notary mode, and both mode) just run
cargo make all, or to run all the unit and integration tests for the main package and all the libraries just runcargo make t, or to run Cargo Watch so it detects whenever you change any code and automatically runs all unit and integration tests and shows if you've encountered any issues then just run it withcargo make testand leave that running in a terminal window whilst your writing all your code so you know you're not breaking anything.And if you want to open the UML diagram just run
cargo make uml.