From e3c7712953673435c1a40a7e1af97e2c7f331e35 Mon Sep 17 00:00:00 2001 From: Rich Geldreich Date: Fri, 3 Feb 2023 13:27:23 -0500 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5511c7f..5ed47c5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -See [timeline](https://raw.githack.com/richgel999/ufo_data/main/timeline.html) +# UFO event timeline processing tool. +Copyright (C) 2023 By Richard Geldreich, Jr. + +## Instructions + +This C++ command line tool reads several source files containing UFO related events, which were compiled from a variety of sources, and converts each of them to JSON. It then sorts all of these events into a single large timeline and outputs them as Markdown. [pandoc](https://pandoc.org/) can then be used to convert this Markdown text to HTML. + +Currently, the tool is Windows only, but it would be trivial to port to Linux/OSX. (I'll do this soon.) To run it: compile the .SLN using Visual Studio 2022. There are no 3rd party dependencies. Run it in the BIN directory. It'll convert all the source files to JSON then output a file named timeline.md.