-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
^LICENSE\.md$ | ||
^rsthemes\.Rproj$ | ||
^\.Rproj\.user$ | ||
^CODE_OF_CONDUCT\.md$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, we pledge to respect all people who | ||
contribute through reporting issues, posting feature requests, updating documentation, | ||
submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for | ||
everyone, regardless of level of experience, gender, gender identity and expression, | ||
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. | ||
|
||
Examples of unacceptable behavior by participants include the use of sexual language or | ||
imagery, derogatory comments or personal attacks, trolling, public or private harassment, | ||
insults, or other unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, | ||
commits, code, wiki edits, issues, and other contributions that are not aligned to this | ||
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed | ||
from the project team. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by | ||
opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant | ||
(https://www.contributor-covenant.org), version 1.0.0, available at | ||
https://contributor-covenant.org/version/1/0/0/. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
<p align=center> | ||
<img src="https://raw.githubusercontent.com/gadenbuie/rsthemes/assets/rsthemes.gif"> | ||
<h1 align="center">{rsthemes}</h1> | ||
</p> | ||
|
||
<!-- badges: start --> | ||
[![](https://img.shields.io/badge/rstudio-1.2.1335-%2381A9D7.svg)](https://www.rstudio.com/products/rstudio/) | ||
![](https://www.r-pkg.org/badges/version/rsthemes) | ||
![](https://img.shields.io/badge/lifecycle-experimental-orange.svg) | ||
<!-- badges: end --> | ||
|
||
|
||
## Installation | ||
|
||
You can install rsthemes from GitHub with: | ||
|
||
``` r | ||
# install.packages("devtools") | ||
devtools::install_github("gadenbuie/rsthemes") | ||
``` | ||
|
||
Then, install the included themes with: | ||
|
||
``` r | ||
rsthemes::install_rsthemes() | ||
``` | ||
|
||
## Usage | ||
|
||
The rsthemes package includes a couple helper functions for exploring the themes. | ||
|
||
``` r | ||
# list installed themes | ||
rsthemes::list_rsthemes() | ||
|
||
# Try all themes | ||
rsthemes::try_rsthemes() | ||
|
||
# Try just the light, dark, or base16 themes, e.g. | ||
rsthemes::try_rsthemes("light") | ||
``` | ||
|
||
Use `rstudioapi::applyTheme()` to activate a theme from the R console, or use *Tools* > *Global Options* > *Appearance* to interactively select a theme. | ||
|
||
``` r | ||
# Use a theme | ||
rstudioapi::applyTheme("One Dark {rsthemes}") | ||
``` | ||
|
||
## Uninstall | ||
|
||
If you want to uninstall all or some of the themes, you can use | ||
|
||
``` r | ||
rsthemes::remove_rsthemes() | ||
|
||
# or just the base16 themes, e.g. | ||
rsthemes::remove_rsthemes("base16") | ||
``` | ||
|
||
*** | ||
|
||
Please note that the 'rsthemes' project is released with a | ||
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). | ||
By contributing to this project, you agree to abide by its terms. |