Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Introductory documentation #141

Open
awwad opened this issue Sep 26, 2017 · 0 comments
Open

Introductory documentation #141

awwad opened this issue Sep 26, 2017 · 0 comments
Assignees

Comments

@awwad
Copy link
Contributor

awwad commented Sep 26, 2017

While the project has tons of documentation in terms of design, implementation, and deployment considerations, and some documentation about the demo, the project lacks introductory documentation explaining this repository and Uptane. That should be remedied.

A breakout on the landing page markdown doc (README) is probably the way to go, with a slightly longer intro blurb.

One of the pages linked to should explain the structure of the repository, the reference implementation and its modules, how to read through them, the demo, and the tests.

@awwad awwad self-assigned this Sep 26, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant