File WORKFLOW.md deleted (index a49597d..0000000) |
1 |
|
--- |
|
2 |
|
title: Workflow cheatsheet |
|
3 |
|
--- |
|
4 |
|
|
|
5 |
|
<!-- I'm a comment --> |
|
6 |
|
|
|
7 |
|
# Step by step |
|
8 |
|
|
|
9 |
|
#. Open a command-line interface (or "Terminal") and make the folder containing the notes the current working directory: |
|
10 |
|
#. Open a command-line interface, cf. <https://www.wikihow.com/Open-a-Terminal-Window-in-Ubuntu>. |
|
11 |
|
#. Change the directory to the right folder, using something like |
|
12 |
|
|
|
13 |
|
``` |
|
14 |
|
cd CSCI_3410/ |
|
15 |
|
``` |
|
16 |
|
|
|
17 |
|
Or, alternatively, |
|
18 |
|
|
|
19 |
|
#. Open the file explorer, |
|
20 |
|
#. Navigate to the notes folder, |
|
21 |
|
#. Make a right-click, "Open in terminal" (or something similar). |
|
22 |
|
|
|
23 |
|
#. Get the latest version of the notes: |
|
24 |
|
|
|
25 |
|
``` |
|
26 |
|
git pull |
|
27 |
|
``` |
|
28 |
|
|
|
29 |
|
#. Compile the figures into `pdf` and convert them to `svg`, using |
|
30 |
|
|
|
31 |
|
``` |
|
32 |
|
make fig |
|
33 |
|
make fig_svg |
|
34 |
|
``` |
|
35 |
|
|
|
36 |
|
If you get errors messages on that step, please report them. |
|
37 |
|
|
|
38 |
|
#. Edit the document using whichever software you like. |
|
39 |
|
|
|
40 |
|
#. Test your edit, using |
|
41 |
|
|
|
42 |
|
``` |
|
43 |
|
make html |
|
44 |
|
make pdf |
|
45 |
|
make odt |
|
46 |
|
``` |
|
47 |
|
|
|
48 |
|
depending on the version you want to see, or |
|
49 |
|
|
|
50 |
|
``` |
|
51 |
|
make all |
|
52 |
|
``` |
|
53 |
|
|
|
54 |
|
if you want to compile them all. |
|
55 |
|
If you are happy with them, go to the next step, otherwise go to the previous step. |
|
56 |
|
|
|
57 |
|
#. Tell git to save your modifications: |
|
58 |
|
|
|
59 |
|
``` |
|
60 |
|
git commit -a -m "My meaningful explanation of what I just did" |
|
61 |
|
``` |
|
62 |
|
|
|
63 |
|
#. Have rocketgit "accepts" your IP, by using |
|
64 |
|
|
|
65 |
|
``` |
|
66 |
|
ssh rocketgit@ssh.rocketgit.com totp val XXXXXX |
|
67 |
|
``` |
|
68 |
|
|
|
69 |
|
where XXXXXX is the code given by the duo application for your rocketgit account. |
|
70 |
|
|
|
71 |
|
#. Push your modification to the server |
|
72 |
|
|
|
73 |
|
``` |
|
74 |
|
git push origin master |
|
75 |
|
``` |
|
76 |
|
|
|
77 |
|
|
|
78 |
|
|
|
79 |
|
To add a file, open a terminal where the file is, and type |
|
80 |
|
|
|
81 |
|
git add <name of the file> |
|
82 |
|
|
|
83 |
|
Then, commit and push. |
|
84 |
|
|
|
85 |
|
Use |
|
86 |
|
|
|
87 |
|
git rm <name of the file> |
|
88 |
|
|
|
89 |
|
to remove it. |
|
90 |
|
|
|
91 |
|
# References |
|
92 |
|
|
|
93 |
|
- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) |
|
94 |
|
- [Git tutorial](http://metatheorem.org/CSCI3300/lectures/git.html) |
|
95 |
|
|
|
96 |
|
# Markdown Syntax |
|
97 |
|
|
|
98 |
|
For the Solution, Problem and Exercises, we use a particular syntax, that is rendered using the `<dd>` and `<dt>` tags in `html`, and that furthermore use pandoc-numbering. |
|
99 |
|
|
|
100 |
|
We can either have in-line, or block, environment, using |
|
101 |
|
|
|
102 |
|
Solution +.# |
|
103 |
|
|
|
104 |
|
: Solution on one line. |
|
105 |
|
We are still on the same line. |
|
106 |
|
|
|
107 |
|
Not in the solution anymore |
|
108 |
|
|
|
109 |
|
Solution +.# |
|
110 |
|
~ |
|
111 |
|
Solution on a block. |
|
112 |
|
Still in the block. |
|
113 |
|
|
|
114 |
|
Still in the block, on a different paragraph. |
|
115 |
|
|
|
116 |
|
Not in the solution anymore |
|
117 |
|
|
|
118 |
|
The indentation makes all the difference in the block environment. |
|