Skip to content

Commit

Permalink
Made changes to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
senthurayyappan committed Oct 2, 2020
1 parent 0486d8c commit 6978f66
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
* ``gmsh-api``

## Installation
* Download the latest release
* For a minimal installation, download a ``native-build`` release.
* For more advanced and reliable results, download a ``taichi-build`` release.
* Open Blender and head over to ``Edit`` -> ``Preferences`` -> ``Add-ons`` -> ``Install``
* Navigate to the downloaded **.zip** file and click ``Install Add-on``

Expand Down
13 changes: 6 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to anton's documentation!
=================================

.. image:: ../GE.gif
:alt: anton

|
.. image:: https://img.shields.io/badge/Blender-2.80%2B-orange
:target: https://www.blender.org/
:alt: Blender
Expand All @@ -25,9 +24,9 @@ Welcome to anton's documentation!
:target: https://github.com/blender-for-science/anton/blob/master/LICENSE.md
:alt: License

.. image:: https://badges.gitter.im/blender-for-science/community.svg
:target: https://gitter.im/blender-for-science/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
:alt: Gitter
.. image:: https://img.shields.io/discord/750488363571740747?color=738ADB&label=Discord&style=flat-square
:target: https://discord.gg/tpq7Yuv
:alt: Discord


What is Generative design?
Expand All @@ -41,7 +40,7 @@ What is anton?
--------------

``anton`` is an open-source generative design framework built on Blender, the open-source 3D creation suite.
At its current stage of development, anton uses a narrow-band topology optimization methodology as a design generator and
At its current stage of development, anton uses a Narrow-Band Topology Optimization methodology as a design generator and
uses implicit surfaces for mesh generation.

.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Installation
Dependencies
------------

* ``taichi-build`` requires `spgrid_topo_opt <https://github.com/imsenthur/spgrid_topo_opt>', a Narrow-Band Topology Optimization framework developed by `Haixiang Liu (University of Wisconsin-Madison) <http://pages.cs.wisc.edu/~cslhxac/>`, `Yuanming Hu (MIT CSAIL) <http://taichi.graphics/me/>`, `Bo Zhu (Dartmouth College) <http://www.dartmouth.edu/~boolzhu/>`, `Wojciech Matusik (MIT CSAIL) <https://cdfg.csail.mit.edu/wojciech>`, `Eftychios Sifakis (University of Wisconsin-Madison) <http://pages.cs.wisc.edu/~sifakis/>`.
* ``taichi-build`` requires `spgrid_topo_opt <https://github.com/imsenthur/spgrid_topo_opt>`, a Narrow-Band Topology Optimization framework developed by `Haixiang Liu (University of Wisconsin-Madison) <http://pages.cs.wisc.edu/~cslhxac/>`, `Yuanming Hu (MIT CSAIL) <http://taichi.graphics/me/>`, `Bo Zhu (Dartmouth College) <http://www.dartmouth.edu/~boolzhu/>`, `Wojciech Matusik (MIT CSAIL) <https://cdfg.csail.mit.edu/wojciech>`, `Eftychios Sifakis (University of Wisconsin-Madison) <http://pages.cs.wisc.edu/~sifakis/>`.
* The following python modules are also required:
* ``Numpy``
* ``Scipy``
Expand All @@ -17,7 +17,7 @@ Dependencies

Installation
------------

* Download the `latest <https://github.com/blender-for-science/anton/releases>`_ release
* For a minimal installation, download a ``native-build`` release.
* For more advanced and reliable results, download a ``taichi-build`` release.
* Open Blender and head over to ``Edit`` -> ``Preferences`` -> ``Add-ons`` -> ``Install``
* Navigate to the downloaded **.zip** file and click ``Install Add-on``

0 comments on commit 6978f66

Please sign in to comment.