search

artefactual / automation-tools

Tools to aid automation of Archivematica and AtoM.
GNU Affero General Public License v3.0
46 stars 33 forks source link

add basic docs about amclient.py script refs #32 #39

Closed timhutch closed 6 years ago

timhutch commented 6 years ago

This is basically a reformatted version of the built-in help text, with a couple minor tweaks.

timhutch commented 6 years ago

I think I managed to resolve the conflict introduced by the addition of the DIP creation section - but there is an extra commit (b90d575) which I'm not sure how to remove. I can resubmit this if it's easier.

timhutch commented 6 years ago

Thanks, I committed those changes ... hopefully that worked (as you will have guessed I haven't worked a lot with github)

Regarding the TOC, I had actually deliberately not added an entry at first, because of a comment in that section about the TOC being automatically generated. Should that be removed?

jraddaoui commented 6 years ago

Thanks @timhutch!

About the TOC section, we're using doctoc to generate it. You'll need to install it with NPM and run doctoc . in the main folder to update that section, that's what the comments are about.

timhutch commented 6 years ago

Will the manually added entry cause problems? I actually contributed this through the GitHub web interface.

jraddaoui commented 6 years ago

I don't think so, but it will add the subsections too. I also just merged https://github.com/artefactual/automation-tools/pull/41, so this needs a rebase from master.

I'll do it and merge, thanks @timhutch!

jraddaoui commented 6 years ago

Merged in https://github.com/artefactual/automation-tools/commit/4688343b77500b888ac975172473f71cad90c303

timhutch commented 6 years ago

Thank you :)