Skip to content
This repository has been archived by the owner on Feb 13, 2018. It is now read-only.

Commit

Permalink
Update of the documentation
Browse files Browse the repository at this point in the history
I updated the documentation in order to give the latest install
information as well as correcting some links

Signed-off-by: Matthieu Berjon <matthieu@berjon.net>
  • Loading branch information
mattberjon committed Feb 26, 2017
1 parent 5329010 commit cf6e4a1
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This project has been developed within the Action and Perception group of the
school of Psychology at Cardiff University. A new audiovisual lab has been
created and needed a bit of code in order to be analyse the data provided by
the measurements and simulations. [Octave][1] has been chosen for several
the measurements and simulations. [Octave][l1] has been chosen for several
reasons:

* Open source software
Expand All @@ -14,12 +14,22 @@ Please, download it, study it, improve it and share it!

## Installation

You have two choices, or you create a copy of repo and add the content to your
patch such as the following:

Copy the files in your home folder `~/` and edit the `~/Octave` file by adding
the following line:

~~~bash
```console
addpath('<directory/where/are/stored/the/files>')
~~~
```

You can as well download the [lastest release][l5] and install it using the
`pkg` command:

```console
$ pkg install somewhere/pkgname-x.y.z.tar.gz
```

## License

Expand All @@ -31,7 +41,7 @@ We’re really happy to accept contributions from the community, that’s the ma
reason why we open-sourced it! There are many ways to contribute, even if
you’re not a technical person.

We’re using the infamous [simplified Github workflow][2] to accept
We’re using the infamous [simplified Github workflow][l2] to accept
modifications (even internally), basically you’ll have to:

* create an issue related to the problem you want to fix (good for traceability
Expand Down Expand Up @@ -65,7 +75,7 @@ Please document as much as possible the steps to reproduce your problem



[1]: https://www.gnu.org/software/octave/
[2]: http://scottchacon.com/2011/08/31/github-flow.html
[3]: https://berjon.net
[l1]: https://www.gnu.org/software/octave/
[l2]: http://scottchacon.com/2011/08/31/github-flow.html
[l4]: https://github.com/mattberjon/psych-head/issues
[l5]: https://github.com/mattberjon/psych-head/tarball/master

0 comments on commit cf6e4a1

Please sign in to comment.