Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
milesdai committed May 17, 2018
1 parent aa7ecb4 commit b3d5967
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Within a math environment, several macros have been defined to make formatting e
| `\C`, `\H`| Displays each letter in text form within a math environment. Equivalent to `\text{letter}`.|
|`\in`, `\out`, `\Th` | Displays each one in text form within a math environment.|

For solutions with a single, concise answer (i.e. solutions that are just a number of a single phrase of text), use `\mans{ans}` inside a math environment and `\tans{ans}` inside a text environment to indicate the final answer. These commands bold the answer and surround it with a box for emphasis and ease of checking. If a problem is a proof or an explanation, then this kind of emphasis does not really make sense, so do not use these commands. Just write the answer as usual.
For solutions with a single, concise answer (i.e. solutions that are just a number or a single phrase of text), use `\mans{ans}` inside a math environment and `\tans{ans}` inside a text environment to indicate the final answer. (These commands stand for **m**ath-**ans**wer and **t**ext-**ans**wer.) These commands bold the answer and surround it with a box for emphasis and ease of checking. If a problem is a proof or an explanation, then this kind of emphasis does not really make sense, so do not use these commands. Just write the answer as usual.

#### Drawing Circuits
It may be helpful in your solution to provide circuit drawings. This can be accomplished using the included custom environment
Expand All @@ -46,7 +46,7 @@ It may be helpful in your solution to provide circuit drawings. This can be acco
...
\end{circuit}
```
This macro handles all the boilerplate code for the circuitikz pacakge. Simply type circuitikz code directly in the body of the environment.
This macro handles all the boilerplate code for the circuitikz pacakge. Simply type circuitikz code directly in the body of the environment -- no need for semicolons or any `\draw` commands that circuitikz requires. Also automatically applies the `american` style within circuitikz.

Also note that each circuit should be accompanied by a label and a caption. The caption is a standard Latex caption, and the label is a standard Latex label that can be referenced. To keep all labels descriptive and unique, use the following convention for all labels:
```
Expand All @@ -55,11 +55,21 @@ fig:<chapterNum>.<exerciseNum>.<figureNum>
For example, suppose the solutions for exercise 3.2 use six different circuit drawings/images. To label the fourth image/circuit, use fig:3.2.4 as the label. Use this notation for images as well as circuits (which are just treated internally as images).

#### Miscellaneous
* `\todo{noteToSelf}` is a handy macro that will insert `noteToSelf` in bolded red text withing the final document as a reminder of unfinished work.
* `\todo{noteToSelf}` is a handy macro that will insert `noteToSelf` in bolded red text within the final document as a reminder of unfinished work.

## Writing Solutions
When writing solutions, do not repeat the original problem statement so as to not violate copyrights. Assume the reader has read the problem and has access to all the same variables presented in the problem and any iamges the problem may reference.

Make sure you are explaining all your steps as well as any formulas used. Do not just apply a formula without at least briefly mentioning it. (Use your best judgement; there is probably no need to explain V=IR in Chapter 5, but in Chapter 1, that might be a good thing to note when you apply it.)

If possible, explain the thought process behind arriving at the solution instead of just throwing out formulas. This helps people learn how to approach new circuits rather than limiting them to circuits they seen before.
If possible, explain the thought process behind arriving at the solution instead of just throwing out formulas. This helps people learn how to approach new circuits rather than limiting them to circuits they seen before.

## Requirements
Compiling the document should require any standard Latex distribution as well as the following packages:
* amsmath
* circuitikz
* enumitem
* float
* geometry

The pdf documents should be kept up to date with each commit and are there for people who only want to view without recompiling the documents.

0 comments on commit b3d5967

Please sign in to comment.