Commit graph

24 commits

Author SHA1 Message Date
Joshua Lock
eaefbd9fda Add securesystemslib[color] to packages installed in the tutorial
colorama is now an optional dependency for securesystemslib, and so isn't
installed by default. However, the repo script uses colorama and doesn't
handle its absence - add securesystemslib[colors] to ensure colorama is
installed.

Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-02-18 15:05:13 +00:00
Sebastien Awwad
67dd649680
DOC: cover possible environment requirements in QUICKSTART
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 15:21:52 -04:00
Sebastien Awwad
2af4d3f12e
DOC: simplify installation instructions in QUICKSTART
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 13:32:43 -04:00
Sebastien Awwad
ed6acd4ef1
minor DOC: label the advanced tutorial as such
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:56:45 -04:00
Sebastien Awwad
1f3e5b6483
DOC: collapse CLI_EXAMPLES.md into CLI.md
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:54:10 -04:00
Sebastien Awwad
5a94d5db3e
minor DOC: fix unfinished sentence, some punctuation
in the QUICKSTARD.md

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:49:25 -04:00
Sebastien Awwad
907186e6a4
DOC: revise quickstart and reorganize tutorials:
- correctly frame the CLI's current state as a tutorial toy.
- provide a friendlier quickstart that puts what it's doing into
  perspective and guides you to next steps.
- provide a better sense of what each tutorial/quickstart doc is
  for.
- make the getting started page slightly more friendly.

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-05 13:44:07 -04:00
Havard
7cc150af40 Context to QUICKSTART.md
Hi, I did the quick-start today and missed some context. This is my suggestion.

Thanks for a cool framework!
Regards Håvard

Signed-off-by: Håvard B Line <havard.line@gmail.com>
2019-02-17 20:05:38 +01:00
Vladimir Diaz
3c04c15150
Remove the notes about the doc being a work in progress in CLI.md and CLI_EXAMPLES.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 17:36:03 -04:00
Vladimir Diaz
473a0b0c12
Add a couple line breaks to help break apart the main text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:21:07 -04:00
Vladimir Diaz
1c3d1ee302
Revise QUICKSTART.md to capture more of what happens in the background
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:07:33 -04:00
Vladimir Diaz
1133bb4ce4
Revise instructions in QUICKSTART.md to remove unnecessary info
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 13:26:38 -04:00
Vladimir Diaz
cb4b95137f
Add installation instructions to QUICKSTART.md for required dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-25 11:53:59 -04:00
Vladimir Diaz
0525b652da
Link to CLI_EXAMPLES from CLI.md and QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-04-10 16:48:34 -04:00
Vladimir Diaz
7af4573a3f
Revise QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-04-06 17:24:15 -04:00
Vladimir Diaz
153afb52ee
Fix links to TUTORIAL.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-30 15:47:51 -05:00
Vladimir Diaz
e336dfb10a
Fix the specified tuf directories in QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-30 12:20:21 -05:00
Vladimir Diaz
025dbe7118
Revise QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-29 17:10:49 -05:00
Vladimir Diaz
09b7d5ea17
Add python3 example and revise format of text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-26 11:39:27 -05:00
Vladimir Diaz
a2bc692260
Edit format of QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-26 11:23:59 -05:00
Vladimir Diaz
d39870ca8f
Relocate extra examples to CLI.md, and link to CLI and Tutorial
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-26 11:16:21 -05:00
Vladimir Diaz
f4e2436ef5
Label steps in QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-25 17:34:39 -05:00
Vladimir Diaz
4f52b7f70c
Add tentative full working example
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-25 17:33:14 -05:00
Vladimir Diaz
930949dc9b
Add QUICKSTART.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-25 17:11:32 -05:00