Add example generated docs

[JoshBrudnak]

Use lojidoc to generate documentation for use as an example of what lojidoc output looks like. Then add a brief description and link to the generated documentation to the readme.

The generated documentation should be put in the examples directory.

[jdemieville]

I can do this!

[jdemieville]

I am getting an error when I run lojidoc. It says that it is generating documentation from the appropriate file, then "Keyword not supported: this" pops up 8 times followed by "thread '' panicked at 'called Result::unwrap() on an Err value: Os { code: 123, kind: Other, message: "The filename, directory name, or volume label syntax is incorrect." }', libcore\result.rs:945:5.

[jdemieville]

There is a note: Run with RUST_BACKTRACE=1 for a backtrace. It does make the appropriate folder with no file within if I use -d, and by using -b it generates a markdown book with a chapter_1.md file with only one line "# Chapter 1"

[JoshBrudnak]

What command and OS are you using to run lojidoc? So far it has only been tested on Linux.

[jdemieville]

Ah, I see. I am using Windows OS so that could be the problem. I have been using the example usage from the readme with the appropriate path and repository URL lojidoc [Project_Path] -c [repository URL] -d docs/

[jdemieville]

It will flag if the directory is wrong with either incorrect file path or no java files found, depending on which is wrong. It is also making the markdown file or the doc folder (depending on which flag I've selected), so that seems to be working correctly. Could it be a consequence of my java program? The folder contains 4 java files, the main class and 3 other classes.

[JoshBrudnak]

No that shouldn't be the issue as long as your java syntax is correct. Is there any indication where in the application it is crashing (My guess would be during the file IO)? I would test it too but I don't have access to a windows computer right now :sob:

[jdemieville]

Here's the repository of the java program I was attempting to run: https://github.com/jdemieville/SherwoodVersusBinary

Maybe see if you can get it to work with this program on Linux. If not, it would be my program and I can test it with one of the java programs that you know it works with!

I tried to run the rust backtrace it suggested, but it said the command was invalid. I was probably using it wrong!

[JoshBrudnak]

¯\(ツ)/¯

[jdemieville]

Ok, so it is either an operating system issue or I have done the commands incorrectly. When I get home, I will mimic the command that you used!

[jdemieville]

I ran the same commands an am getting the same error:

Generating documentation from SherwoodVersusBinary/src/

Keyword not supported: this Keyword not supported: this Keyword not supported: this Keyword not supported: this Keyword not supported: this Keyword not supported: this Keyword not supported: this Keyword not supported: this thread '' panicked at 'called Result::unwrap() on an Err value: Os { code: 123, kind: Other, message: "The filename, directory name, or volume label syntax is incorrect." }', libcore\result.rs:945:5 note: Run with RUST_BACKTRACE=1 for a backtrace.

Documentation finished. Generated 4 markdown files.

[jdemieville]

Sorry I can't get this example up for you! It's a cool concept!