Skip to content

Commit 423b2f6

Browse files
committed
simplify README
1 parent 3106ffe commit 423b2f6

File tree

2 files changed

+8
-35
lines changed

2 files changed

+8
-35
lines changed

README.md

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,51 @@
11
[![](https://img.shields.io/badge/Octave-CI-blue?logo=Octave&logoColor=white)](https://github.com/cpp-lln-lab/template_PTB_experiment/actions)
22
![](https://github.com/Remi-gau/template_matlab_analysis/workflows/CI/badge.svg)
33
[![codecov](https://codecov.io/gh/Remi-gau/template_matlab_analysis/branch/master/graph/badge.svg)](https://codecov.io/gh/cpp-lln-lab/template_PTB_experiment)
4-
[![Build Status](https://travis-ci.com/Remi-gau/template_matlab_analysis.svg?branch=master)](https://travis-ci.com/cpp-lln-lab/template_PTB_experiment)
54

6-
# Template repository for matlab analysis project
5+
# Template repository for psycthoolbox experiment
76

87
## Content
98

109
```bash
1110
├── .git
12-
│ ├── COMMIT_EDITMSG
13-
│ ├── FETCH_HEAD
14-
│ ├── HEAD
15-
│ ├── ORIG_HEAD
16-
│ ├── branches
17-
│ ├── config
18-
│ ├── description
19-
│ ├── hooks
20-
│ │ ├── pre-commit.sample
21-
│ │ └── pre-push.sample
22-
│ ├── ...
23-
│ └── ...
2411
├── .github # where you put anything github related
2512
│ └── workflows # where you define your github actions
2613
│ └── moxunit.yml # a yaml file that defines a github action
27-
├── lib # where you put the code from external libraries (mathworks website or other github repositories)
14+
├── lib # external libraries (mathworks website or other github repositories)
2815
│ └── README.md
2916
├── src # where you put your code
3017
│ ├── README.md
3118
│ └── miss_hit.cfg
3219
├── tests # where you put your unit tests
3320
| ├── README.md
3421
| └── miss_hit.cfg
35-
├── .travis.yml # where you define the continuous integration done by Travis
3622
├── LICENSE
3723
├── README.md
38-
├── requirements.txt # list of python packages used in this repo: to install `pip install -r requirements.txt`
24+
├── requirements.txt # python packages used: to install `pip install -r requirements.txt`
3925
├── miss_hit.cfg # configuration file for the matlab miss hit linter
4026
└── initEnv.m # a .m file to set up your project (adds the right folder to the path)
4127
```
4228

43-
## Keeping your code stylish: miss hit linter
44-
45-
## Python environment
46-
47-
More on this
48-
[here](https://the-turing-way.netlify.app/reproducible-research/renv/renv-package.html)
49-
50-
[Conda cheat sheet](https://docs.conda.io/projects/conda/en/4.6.0/_downloads/52a95608c49671267e40c689e0bc00ca/conda-cheatsheet.pdf)
51-
52-
## Testing your code
53-
54-
## Continuous integration
55-
5629
## How to install and use this template
5730

5831
By using the
5932
[template PTB experiment repository](https://github.com/cpp-lln-lab/template_PTB_experiment):
60-
you can create a new repository on your github account with all the basic folders,
61-
files and submodules already set up. You only have to then clone the repository
62-
and you are good to go.
63-
33+
you can create a new repository on your github account with all the basic
34+
folders, files and submodules already set up. You only have to then clone the
35+
repository and you are good to go.
6436

6537
## How to install and run
6638

6739
Install
40+
6841
```
6942
git clone --recurse-submodules https://github.com/your_github_account/the_name_of_your_new_experiment.git
7043
```
7144

7245
Set parameters in `setParameters.m`
7346

7447
Run
48+
7549
```
7650
mainScript
7751
```

notebooks/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)