A completed project directory listing

[cwickham]

As part of #429 I want to include a directory tree for the final zipf directory, but I'm not confident enough on the packaging chapter to do it myself.

Should https://github.com/merely-useful/merely-useful.github.io/tree/book/zipf represent this final state? I don't think it currently does, because it is missing things, e.g. docs/?

I guess at some point this will be part of #359.

[DamienIrving]

Having https://github.com/merely-useful/merely-useful.github.io/tree/book/zipf represent the final state is a great idea.

Here's what I think is the final state is, with [notes] to indicate when each file is introduced. I'll create a PR soon to add all the missing files to https://github.com/merely-useful/merely-useful.github.io/tree/book/zipf.

├── CONDUCT.md   [introduction]
├── KhanVirtanen2020.md   [provenance]
├── LICENSE.md   [introduction]
├── README.rst   [starts as .md in introduction and changes to .rst in packaging]
├── environment.yml   [provenance]
├── Makefile   [automate]
├── setup.py   [packaging]
├── requirements.txt   [packaging]
├── bin   [changes name from bin to zipf in packaging]
│   ├── book_summary.sh   [bash-advanced]
│   ├── collate.py   [scripting]
│   ├── countwords.py   [scripting]
│   ├── plotcounts.py   [scripting]
│   ├── plotparams.yml   [configuration]
│   ├── test_zipfs.py   [testing]
│   └── utilities.py   [scripting]
├── data
│   ├── README.md   [introduction]
│   ├── dracula.txt   [introduction]
│   ├── frankenstein.txt   [introduction]
│   ├── jane_eyre.txt   [introduction]
│   ├── moby_dick.txt   [introduction]
│   ├── sense_and_sensibility.txt   [introduction]
│   ├── sherlock_holmes.txt   [introduction]
│   └── time_machine.txt   [introduction]
├── docs
│   ├── Makefile   [packaging]
│   ├── conf.py   [packaging]
│   ├── index.rst   [packaging]
│   └── source
│   │   ├── collate.rst   [packaging]
│   │   ├── countwords.rst   [packaging]
│   │   ├── modules.rst   [packaging]
│   │   ├── plotcounts.rst   [packaging]
│   │   ├── test_zipfs.rst   [packaging]
│   │   └── utilities.rst   [packaging]
├── results
│   ├── collated.csv   [automate]
│   ├── dracula.csv   [scripting]
│   ├── dracula.png   [git-cmdline]
│   ├── frankenstein.csv   [automate]
│   ├── jane_eyre.csv   [scripting]
│   ├── jane_eyre.png   [scripting]
│   ├── moby_dick.csv   [scripting]
│   ├── plotcounts.png   [automate; should probably be called collated.png]
│   ├── sense_and_sensibility.csv   [automate]
│   ├── sherlock_holmes.csv   [automate]
│   └── time_machine.csv   [automate]
└── test_data
    ├── random_words.txt   [testing]
    └── risk.txt   [testing]

[cwickham]

This is great! But, a lot more complicated that I expected. I'm going to use an abbreviated version in the Intro with just enough to talk about the overall structure.

I'm going to propose we include this as an Appendix, with all the notes as links to the part of the both the files are added.

[lwjohnst86]

With #434 merged, can this be closed?

[cwickham]

Yup!