From 7cd275fada6c68ac6f2390c9168bf816bb197c69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juhani=20Krekel=C3=A4?= Date: Sat, 1 Sep 2018 22:38:01 +0300 Subject: [PATCH] Start writing documentation --- README.md | 18 ++++++++++++++++++ src/main-export-known-hosts.py | 1 + 2 files changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ae5f9f --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Name +---- + +*SSH* *W*eb *o*f *T*rust + +TODO +---- + +* `egrep 'TODO|FIXME|XXX' src/*.py` +* Convert format description to mandoc +* Write manpages +* Add `install` and `uninstall` makefile targets + +License +------- + +Both the sshwot specification and the reference implementation contained +here are licensed under Creative Commons Zero v1.0 Universal. diff --git a/src/main-export-known-hosts.py b/src/main-export-known-hosts.py index 2ad8e36..d27f7b5 100644 --- a/src/main-export-known-hosts.py +++ b/src/main-export-known-hosts.py @@ -6,6 +6,7 @@ import process_known_hosts import write_file def main(): + # TODO: Provide a way to add comments parser = argparse.ArgumentParser( description = """Export .ssh/known_hosts as a sshwot file. By default the output is written to stdout.""",