Skip to content

Commit 6978f66

Browse files
Made changes to docs.
1 parent 0486d8c commit 6978f66

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
* ``gmsh-api``
2020

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

docs/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to anton's documentation!
7-
=================================
8-
96
.. image:: ../GE.gif
107
:alt: anton
118

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

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

3231

3332
What is Generative design?
@@ -41,7 +40,7 @@ What is anton?
4140
--------------
4241

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

4746
.. toctree::

docs/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Installation
88
Dependencies
99
------------
1010

11-
* ``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/>`.
11+
* ``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/>`.
1212
* The following python modules are also required:
1313
* ``Numpy``
1414
* ``Scipy``
@@ -17,7 +17,7 @@ Dependencies
1717

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

0 commit comments

Comments
 (0)