search

OutpostUniverse / OP2Utility

C++ library for working with Outpost 2 related files and tasks.
MIT License
4 stars 0 forks source link

Update ReadMe #316

Closed DanRStevens closed 4 years ago

DanRStevens commented 4 years ago

I split off the ReadMe.md changes from PR #313. I added a few fixes that I noticed.

Changes look good. Having example code in nice.

The last section on map tiles seems to just show function prototypes rather than example code.

More long term, it would be nice to have compiler checked code examples. Maybe we can pull examples from the unit tests. If there is insufficient good example code, perhaps we can add to the unit tests.

Brett208 commented 4 years ago

Thanks for separating this out. I hadn't finished the map section.

-Brett

Brett208 commented 4 years ago

I think I'm complete with the readme update. There are basic code examples for everything but the stream and bitmap libraries. I feel like the bitmap library really isn't mature enough to document. The stream library documentation might be nice, but I didn't feel up to writing it.

I'd like to merge this and canvas the forums to see if anyone would read it and provide feedback (perhaps techcor) before continuing to work on it.

I pasted all the code examples into Visual Studio and fixed any errors that cropped up when compiling. Hopefully this will keep the quality of the examples up. I wouldn't mind in the future trying to use the unit tests for documentation or something else, but I don't think we are there yet on unit test maturity.

-Brett