Skip to content

Commit

Permalink
Merge pull request #3 from azerupi/master
Browse files Browse the repository at this point in the history
Added an install section and example section
  • Loading branch information
JacquesLucke committed Dec 31, 2014
2 parents b08ea6c + 35d8738 commit 063eff5
Show file tree
Hide file tree
Showing 7 changed files with 59 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
Animation-Nodes-Documentation
=============================

Official documentation repository for the Animation Nodes Project.
http://animation-nodes-documentation.readthedocs.org/en/latest/
http://animation-nodes-documentation.readthedocs.org/en/latest/

This is the Official **documentation** repository for the Animation Nodes Project.

If you want to contribute:

1. Fork https://github.com/JacquesLucke/Animation-Nodes-Documentation
2. Add some useful description of nodes, images, examples, correct typos, ...
3. Create a pull request to integrate your modifications into the official repository
4. Wait for your modifications to be accepted
5. Congratulations, you have added some very useful information for future users!


**You don't know what Animation-Nodes is?**

Check it out! It's an awesome Blender add-on to easily animate about everything with a node based setup!

You can find the official **Animation-Nodes** repository at
https://github.com/JacquesLucke/animation-nodes
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Animation Nodes Documentation
=========================================================

Welcome to the official documentation of **Animation-Nodes**.

Animation nodes is a `Blender <http://www.blender.org/>`_ add-on to animate about everything in Blender by using nodes.

Using nodes grants you the ability to create complex and precise animations in a structured and centralized way.

.. toctree::
:maxdepth: 3

Expand Down
10 changes: 10 additions & 0 deletions docs/user-guide/examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Examples of use
================

A formal description of every node, it's inputs and outputs, is good. But real complete examples are better! Don't you think?

This section (will) include several examples of what you can accomplish with Animation-Nodes and how you can accomplish it.

.. toctree::
:maxdepth: 1

2 changes: 2 additions & 0 deletions docs/user-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ User Guide
.. toctree::
:maxdepth: 2

install/install
nodes/index
examples/index
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/user-guide/install/install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
How to Install?
=====

To install Animation-Nodes

1. download the zip file at the official repository https://github.com/JacquesLucke/animation-nodes

.. image:: zip.png

**Don't extract / unzip the file.**

2. Open Blender

3. Go to the User Prefereces in the add-on tab

4. click install from file and choose the zip file

5. Activate the add-on and you are **done**!

You can now find the Animation-Nodes editor in the node editor.

.. image:: animation_node_editor.png
Binary file added docs/user-guide/install/zip.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 063eff5

Please sign in to comment.