cgsecurity / testdisk

TestDisk & PhotoRec
https://www.cgsecurity.org/
GNU General Public License v2.0
1.55k stars 190 forks source link

Consider putting brief build instructions in README.md, and doc as gitmodule #86

Closed HinTak closed 4 years ago

HinTak commented 4 years ago

I was trying to build from git, and took a while - I see automake / autoconf / autoheader are involved, then I compared with the WIP tar ball, and was about to file a bug until I saw the reference to testdisk_documentation in the cywin / window issue.

So I suggest inserting these minimum instructions at the top level Readme.md:

cd testdisk
mkdir config
autoreconf --install -W all -I config
./configure
make

And also put the testdisk_documentation repo in the .gitmodule file and or also mention it? This was at least the next person would know where to look after cloning.

HinTak commented 4 years ago

Or, create a small autogen.sh like some other project for those few lines? compile.sh is also confusing at the top level.