Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ltalirz committed Apr 29, 2019
1 parent e4fe0e5 commit b514cc5
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,31 @@

# AiiDA tutorials

This repository contains a collection of texts used for
various AiiDA tutorials.
The official place to find materials from AiiDA tutorial events,
interactive demos and videos.

Visit http://aiidateam.github.io/aiida-tutorials
Visit http://aiida-tutorials.readthedocs.org

## Building locally
## Contributing

We highly welcome contributions of

* links to new tutorial materials
* corrections of existing tutorial materials

If you would like to contribute a fix or a link to a new tutorial resource, please:

* Fork this repository
* Make your changes
* Submit a [pull request](https://github.com/aiidateam/aiida-tutorials/pulls)

If you have a question, feel free to just [open an issue](https://github.com/aiidateam/aiida-tutorials/issues/new).

## Building the web site locally

```
cd docs
git clone https://github.com/aiidateam/aiida-tutorials.git
cd aiida-tutorials/docs
pip install -r requirements.txt
make
# open build/html/index.html
Expand Down

0 comments on commit b514cc5

Please sign in to comment.