You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think README should be an overview of the repository as is the standard/best practice on Github. And the specification should be in a file named OmniSpecification or something similar.
One reason for doing this is that as we clean up the specification, we're very likely to split it into multiple documents and the README can serve as an index that "points to" those documents.
Move README.adoc to OmniSpecification-v0.6.adoc and update the README to point at both the old and new specifications during the transition period.
Complete version 0.7 of the specification
Update the README to reflect the new specification and remove the link to the old version (the spec itself can have a link to the old version in an appendix)
msgilligan
changed the title
Rename specification file from README to OmniSpecification
Start work on revised specification in file name OmniSpecification -- move spec out of README file
Mar 26, 2020
I think
README
should be an overview of the repository as is the standard/best practice on Github. And the specification should be in a file namedOmniSpecification
or something similar.One reason for doing this is that as we clean up the specification, we're very likely to split it into multiple documents and the
README
can serve as an index that "points to" those documents.@CraigSellars @achamely @marvgmail @dexX7 Thoughts?
The text was updated successfully, but these errors were encountered: