search

perun-network / perun-fabric

go-perun Hyperledger Fabric chaincode and backend
Apache License 2.0
3 stars 0 forks source link

Add READMEs in all major directories #2

Closed RmbRT closed 2 years ago

RmbRT commented 2 years ago

1-sentence descriptions of the packages should suffice for now.

RmbRT commented 2 years ago

@leandro-ro

matthiasgeihs commented 2 years ago

Adding READMEs to all directories sounds a little bit overkill to me. For documenting go packages the go doc should be sufficient and preferred.

RmbRT commented 2 years ago

It was just pretty hard to navigate the project during the meeting today, and it would help to be able to see what does what when browsing the repo. Those readmes can be deleted again later.

matthiasgeihs commented 2 years ago

In this case I suggest you document that in a separate document.