README.md in wb-1.0.0 vs README.md in wb-1.0.1
- old
+ new
@@ -1,9 +1,17 @@
# WB -- Software Engineers's Workbook
-[Background reading: Lab Notebooking for the Software Engineer](https://blog.nelhage.com/2010/06/lab-notebooking-for-the-software-engineer/)
+[Background reading: Lab Notebooking for the Software Engineer](https://blog.nelhage.com/2010/06/lab-notebooking-for-the-software-engineer/):
+- Only append to the workbook
+- [Keep automatic backups](https://github.com/JuanitoFatas/wb/issues/1)
+- What to note?
+ - Measurement
+ - Non-trival search and found something
+ - Explicit design decision
+ - Whenever you wish you had written down
+
## Installation
$ gem install wb
## Usage
@@ -24,27 +32,36 @@
work: "~/Dropbox/workbooks/work.md"
project:
note_folder: ".note"
```
-To open a workbook:
+and add following to `~/.gitignore_global`:
```
+# ignore project notes by https://github.com/juanitofatas/wb
+/.note/
+```
+
+To open a global workbook:
+
+```
wb
```
This will open workbook based on the working hour set in `~/.workbookrc`.
Inside working hour `wb` equals to:
```
wb work
+# opens "~/Dropbox/workbooks/work.md
```
Outside working hour `wb` equals to:
```
wb personal
+# opens "~/Dropbox/workbooks/personal.md
```
Create a new workbook in the project you are working:
```