Skip to content

Commit

Permalink
include gif in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzwalthert committed Dec 5, 2016
1 parent 3cb8aff commit f246538
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ better.
<!-- You can learn more about structuring code in [Bono Usu](https://github.com/lorenzwalthert/bonousu/blob/devel/docs/commenting-code.html),
a guide for good practice in R programming. -->

![](https://raw.githubusercontent.com/lorenzwalthert/strcode/master/man/demo/demo_strcode_v0.1.0.gif)


# Installation
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ README
The `strcode` (short for structuring code) package is an [RStudio Add-in](https://rstudio.github.io/rstudioaddins/) that lets you quickly add code block separators so you can organize your code better. <!-- You can learn more about structuring code in [Bono Usu](https://github.com/lorenzwalthert/bonousu/blob/devel/docs/commenting-code.html),
a guide for good practice in R programming. -->

![](https://raw.githubusercontent.com/lorenzwalthert/strcode/master/man/demo/demo_strcode_v0.1.0.gif)

Installation
============

Expand Down Expand Up @@ -47,8 +49,8 @@ You can notice from above that
- The breaks characters `___`, `...`, `. .` were chosen such that they reflect the level of granularity, namely `___` has a much higher visual density than `. .`.
- Each block has an (optional) short comment on what the next block is about.

The separators do all have length 80. The value is looked up in the global option `strcode.char.lenght` and can be changed by the user (either every session manually or using .Rprofile).
For each of the introduced separator, there is an Add-in function. You can also call them from the console
The separators do all have length 80. The value is looked up in the global option `strcode.char.length` and can be changed by the user (either every session manually or using .Rprofile).
For each of the introduced separators, there is an Add-in function. You can also call them from the console

- `strcode::insert_l1_break()`
- `strcode::insert_l2_break()`
Expand Down

0 comments on commit f246538

Please sign in to comment.