Missing dev instructions

Shopify / ejson

EJSON is a small library to manage encrypted secrets using asymmetric encryption.

MIT License

1.34k stars 62 forks source link

Missing dev instructions #47

Closed viraptor closed 5 years ago

viraptor commented 6 years ago

I wanted to fix one of the issues, but I got stuck for a long time just trying to get ejson to build. It would be great if there was a short section in the README about:

what go version is expected
how are the dependencies managed
how to go from git clone ... on a completely clean host, to a built ejson binary

noqcks commented 5 years ago

I also ran into this problem. Would love some more documentation/build setups for non-shopify machines.

I don't think it's a bug either @catherinejones, more of an improvement.

lavoiesl commented 5 years ago

Better documentation would definitely be great; but in the mean time, you can interpret what is in https://github.com/Shopify/ejson/blob/master/dev.yml to get a sense of what is needed.

burke commented 5 years ago

Added basic CONTRIBUTING.md to master.