forked from khanhicetea/today-i-learned
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.template
48 lines (32 loc) · 1.4 KB
/
README.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Today I Learned
We constantly learn new things. This is a repo to share those learnings.
TILs are short Markdown documents (a few sentences + example code) explaining
concepts, bits of syntax, commands, or tips we've recently learned.
Today-I-Learned (TIL) is inspired by Thoughbot, TIL is a repository for everyone to share what we have learn today.
This repo has a tool that help you to manage and write down what you learned in scientific way.
# What I learned
{TOC}
# Instruction
- Step 1: Fork this repo (blank-repo with **only tool** and **readme file**).
- Step 2: Start writting down what you learned in **everyday**.
+ Create a **topic** by:
```bash
./til <CATEGORY> <SUBJECT> [EDITOR]
```
- Ex:
```bash
./til bash "Bash Conditional Expression" vim
```
- If you tired of typing the quote mark:
```bash
./til bash Bash-Conditional-Expression
./til bash Bash=Conditional=Expression
```
DO NOT mix the `-` and `=` together!
+ It will create 1 file whose name which is the SUBJECT in lower case: `bash/160510-bash-conditional-expression.md`.
+ **Write** it! **Save** it!
- Step 3: Commit what you learned today by `./til commit`. After that, if you want to push it to _repository_, just **Enter**
# License
© 2018 khanhicetea.
Distributed under the [Creative Commons Attribution License][license].
[license]: http://creativecommons.org/licenses/by/3.0/