Commit 3c2c22f7 authored by Ahmad Alkadri's avatar Ahmad Alkadri 🎧
Browse files

Editing the README

parent fd40bc80
......@@ -4,4 +4,7 @@
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/R/correctingmatTHz.R="1AFE8C53"
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/R/matrixlineextractions.R="AAFF1D0C"
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/R/plottingfunctions.R="630E2B53"
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/README.Rmd="E09D53C9"
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/README.Rmd.md="F3B7555B"
/Users/alkadri/Documents/These/Works/Current models/R_packages/rterahertz/README.md="3CBD3EB8"
/Users/alkadri/Documents/These/Works/Current models/R_packages/simpleRCRU/README.Rmd="B1AF469F"
---
title: "R-Terahertz"
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
This is an R package containing many functions used for working with Terahertz scanning/imaging data.
This package is licensed under MIT License.
The current main contributors, direct and indirect, of this package are:
+ Ahmad Alkadri (ahmad.alkadri@umontpellier.fr)
+ Olivier Arnould
+ Delphine Jullien
+ Joseph Gril
+ Dominique Coquillat
+ Nina Dyakonova
This package is constantly under development for now.
We're still actively working with the Terahertz technique.
Active developments and updates will be made regularly.
Any further questions should be directed by e-mail to ahmad.alkadri@umontpellier.fr.
## How to install
For installing the package on your computer, simply open your R (via console or IDE such
as RStudio) and type:
```
devtools::install_git(
"https://git-xen.lmgc.univ-montp2.fr/alkadri/rterahertz.git",
credentials = git2r::cred_user_pass("user.name", getPass::getPass())
)
```
Where **user.name** is the email address that you use for logging in to
https://git-xen.lmgc.univ-montp2.fr/. Once you run that, you will be prompted
to enter your password that you usually use to logging in to LMGC's git.
Don't forget, you need to have *devtools*, *git2r*, and *getPass* packages
installed on your R in your computer.
# RTerahertz
R-Terahertz
================
This is an R package containing many functions used for working with Terahertz scanning/imaging data.
This package is licensed under MIT License.
The current main contributors, direct and indirect, of this package are:
This is an R package containing many functions used for working with
Terahertz scanning/imaging data. This package is licensed under MIT
License. The current main contributors, direct and indirect, of this
package are:
+ Ahmad Alkadri (ahmad.alkadri@outlook.com)
+ Olivier Arnould
+ Delphine Jullien
+ Joseph Gril
+ Dominique Coquillat
+ Nina Dyakonova
- Ahmad Alkadri (<ahmad.alkadri@umontpellier.fr>)
- Olivier Arnould
- Delphine Jullien
- Joseph Gril
- Dominique Coquillat
- Nina Dyakonova
This package is constantly under development for now.
We're still actively working with the Terahertz technique.
Active developments and updates will be made regularly.
Any further questions should be directed by e-mail to ahmad.alkadri@outlook.com.
This package is constantly under development for now. We’re still
actively working with the Terahertz technique. Active developments and
updates will be made regularly. Any further questions should be directed
by e-mail to <ahmad.alkadri@umontpellier.fr>.
## How to install
For installing the package on your computer, simply open your R (via
console or IDE such as RStudio) and type:
devtools::install_git(
"https://git-xen.lmgc.univ-montp2.fr/alkadri/rterahertz.git",
credentials = git2r::cred_user_pass("user.name", getPass::getPass())
)
Where **user.name** is the email address that you use for logging in to
<https://git-xen.lmgc.univ-montp2.fr/>. Once you run that, you will be
prompted to enter your password that you usually use to logging in to
LMGC’s git. Don’t forget, you need to have *devtools*, *git2r*, and
*getPass* packages installed on your R in your computer.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment