Author Topic: My project directory structure  (Read 3336 times)

MichaelK

  • Regular Member
  • *
  • Posts: 11
    • M. J. Kwayisi
My project directory structure
« on: January 03, 2013, 06:00:44 PM »
As part of my "early post" commitment on this board, I'm sharing how I organize my project directory. I have 6 top-level folders
  • bin: binary files (final executables)
  • dep: runtime dependency files required by the final executable. I have written a simple batch script that builds my projects so it additionally copies the contents of this folder to the bin directory so I can simultaneously test it if I need to.
  • doc: where all documentation pertaining to the project are kept.
  • obj: contains the temporary generated object files (primarily for debugging)
  • res: holds any resources (images, etc.) that need to be built with the project.
  • src: where all my source code go.
Aside the top-level folders, I have 6 other files in the root folder:
  • build.bat: batch script to build the project.
  • build.ini: configuration settings to help the batch script out.
  • CHANGES: change log of the projects (if any, mostly blank!).
  • LICENSE: license of the project (mostly empty as well).
  • project.pnproj: main project file as I use Programmer's Notepad for coding.
  • README: the read me of the project.
Ummm, what do you think of the layout. Is it OK or can I make it better.
So [or eax, 0FFh] == [mov eax, -1]? Not again, asm!

jj2007

  • Member
  • *****
  • Posts: 13030
  • Assembler is fun ;-)
    • MasmBasic
Re: My project directory structure
« Reply #1 on: January 03, 2013, 06:34:15 PM »
Hi Michael,

First of all: Welcome to the Forum :icon14:

As to your project structure, it looks logical but a bit "top-down". For the kind of projects you will typically create here, a single folder with an asm and rc file is probably enough. For your inspiration, have a look at how \Masm32\examples is organised. Tips & tricks is also worth reading in this respect.

Have a nice day,
JJ

Gunther

  • Member
  • *****
  • Posts: 4090
  • Forgive your enemies, but never forget their names
Re: My project directory structure
« Reply #2 on: January 04, 2013, 02:06:13 AM »
Hi Michael,

welcome to the forum.

Gunther
Get your facts first, and then you can distort them.

MichaelK

  • Regular Member
  • *
  • Posts: 11
    • M. J. Kwayisi
Re: My project directory structure
« Reply #3 on: January 04, 2013, 09:16:48 AM »
JJ: Thank you very much for the link. It was highly invaluable as I'm just starting out with MASM.

Gunther: Thanks as well. I've enjoyed the content here so far.
So [or eax, 0FFh] == [mov eax, -1]? Not again, asm!