This repo containes a bunch of automation scripts for managing my DVC COMSC-165 labwork.
It creates a set of folders and C++ starter files to quickly get started with the labs.
You'll need to run this step if you want to run this command anywhere else.
cd lab-creator
npm link
create-lab --id <id> --parts <parts>
id
= the identifier of a lab (ex. the ID in 'Lab 1A' is '1A')- if the
id
is two characters big (like '1A' or '3D'), then the generated parts directory will be 'part-1', 'part-2', etc. - if the
id
is one character big (like '2' or '6'), then the generated parts directory will be 'part-A', 'part-B', etc.
- if the
parts
= the number of parts in a part
There's also a config that let's you edit some of the global settings. Duplicate lab-creator/config.default.json
, call it config.json
, and fill out all the fields.
Config settings:
labs-directory
- The root directory of the labscourse
- The course number (ex. COMSC-165)author
- Your namegist-code-url
(optional) - The url for pulling boilerplate code from a Gist hosted from GitHub.indentation
- Settings for indentation for the generated codetype
- either 'spaces' or 'tabs' (defaults to 'tabs')amount
- The amount of spaces to indent with (doesn't apply to tabs)
It compiles the code and screenshots into a Word document for each part detected.
You'll need to run this step if you want to run this command anywhere else.
cd lab-compiler
npm link
compile-lab --id <id> --part [part]
id
= the identifier of a lab (ex. the ID in 'Lab 1A' is '1A')- if the
id
is two characters big (like '1A' or '3D'), then the expected parts directory will be 'part-1', 'part-2', etc. - if the
id
is one character big (like '2' or '6'), then the expected parts directory will be 'part-A', 'part-B', etc.
- if the
part
= the specific part number to compile; if this is left out, all parts will be compiled
There's also a config that let's you edit some of the global settings. Duplicate lab-compiler/config.default.json
, call it config.json
, and fill out all the fields.
Config settings:
labs-directory
- The root directory of the labsauthor
- Your name
It cleans any generated files (i.e. '.exe', '.o', and '.docx' files) after you are done with a lab
You'll need to run this step if you want to run this command anywhere else.
cd lab-cleaner
npm link
clean-labs
There's also a config that let's you edit some of the global settings. Duplicate lab-cleaner/config.default.json
, call it config.json
, and fill out all the fields.
Config settings:
labs-directory
- The root directory of the labs