udoprog / c10t

A minecraft cartography tool
Other
225 stars 50 forks source link

Building documentation is old, inconsistent #144

Closed srawlins closed 12 years ago

srawlins commented 13 years ago

In README.md, the following targets are listed: c10t, c10t-lib, c10t-debug, and c10t-test. However, at least c10t-lib and c10t-test are no longer targets:

craig:c10t sam$ make c10t-lib make: * No rule to make target `c10t-lib'. Stop. craig:c10t sam$ make c10-test make: * No rule to make target`c10-test'. Stop.

However, I feel like perhaps equivalent targets for "c10t-lib" might be c10t-mc and c10t-nbt? This is a guess based on the .a libraries found in src/mc and src/nbt after making all.

Also, the wiki (eg https://github.com/udoprog/c10t/wiki/Building-on-Mac-OS-X) and README.md don't agree on build steps (building in ./build/ rather than ./). Are the differences important? I have been building the wiki way (in ./) with success.

Along with the build targets, I guess people would want to know the difference between c10t-mc and c10t-nbt. I imagine a list of functions (found in src/mc/.hpp and src/nbt/.hpp) would be sufficient preliminary documentation, and I could provide this in the form of wiki pages...

craig:c10t sam$ ./c10t --version c10t - a cartography tool for minecraft version: git ca74aab, built on Mar 6 2011 by: Udoprog johnjohn.tedro@gmail.com et. al (see README) site: http://github.com/udoprog/c10t

My specific platform is OS X 10.6, 32-bit.

udoprog commented 12 years ago

The most up to date documentation should be in the project itself, the wiki is not widely used or employed since the number of devs is varying and sporadic.

Documentation is good, but it will most likely be outdated very quickly.