Update README.md

This commit is contained in:
Rich Geldreich 2023-02-03 13:27:23 -05:00 committed by GitHub
parent 491770ff06
commit e3c7712953
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.