Added minor clarification for building the patched SWIG on Linux

idapython / src

IDAPython project for Hex-Ray's IDA Pro

http://www.hex-rays.com/

Other

1.42k stars 287 forks source link

Added minor clarification for building the patched SWIG on Linux #39

Closed 0xeb closed 1 year ago

aundro commented 1 year ago

Elias,

currently we have instructions (and build.py-related example commands) in both build.py itself, and in BUILDING.txt. I think we should keep only 1 place, and point there. And I think the best logical place for that is build.py itself, since it's the most "downstream".

I would make BUILDING.txt simply end with "see python3 build.py --help for help".

What do you think?

0xeb commented 1 year ago

I think we should consolidate instructions into the landing page into README.md like most projects do. We would then rename BUILDING.txt to BUILDING.md and clean it up. Get rid of .txt files.

Perhaps we can also link to the hex-rays blog post (w.r.t building on Windows).

Let me think about what you suggested and see how much repetition we have.

Thanks!

aundro commented 1 year ago

I agree with the .txt -> .md move. But indeed I'd like to avoid repetition.