Update README.md

This commit is contained in:
Rich Geldreich 2023-02-04 13:52:50 -05:00 committed by GitHub
parent 0446d09a7d
commit dd1ab6a03a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -11,7 +11,7 @@ Data files (in 'bin' directory): George M. Eberhart - Copyright 2022, LeRoy Pea
## Instructions ## 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 and the JSON file "majestic.json". [pandoc](https://pandoc.org/) can then be used to convert this Markdown text to HTML. 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 the Markdown file "timeline.md" and the JSON file "majestic.json". [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 external 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. 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 external 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.