Updated readme

mpasson · Jan 30, 2023 · 0ab02f0 · 0ab02f0
1 parent 6f5732e
commit 0ab02f0
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,6 @@
 *.aux
 .idea
 examples
-docs
+docs-build
 Docs/generated
 Docs/jupyter/.ipynb_checkpoints
diff --git a/Docs/index.rst b/Docs/index.rst
@@ -6,8 +6,10 @@
 A_FMM's documentation
 ==============================================
 
+This is a Python implementation the Aperiodic-Fourier Modal Method, a fully vectorial method for solving Maxwell equations that combines a Fourier-based mode solver and a scattering matrix recursion algorithm to model full 3D structures. This approach is well suited to calculate modes, transmission, reflection, scattering and absorption of multi-layered structures. Moreover, support for Bloch modes of periodic structures allows for the simulation of photonic crystals or waveguide Bragg gratings.
+
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :caption: Contents:
    :numbered:
 

diff --git a/README.md b/README.md
@@ -1,7 +1,14 @@
+[![Documentation Status](https://readthedocs.org/projects/a-fmm/badge/?version=latest)](https://a-fmm.readthedocs.io/en/latest/?badge=latest)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![MIT](https://img.shields.io/github/license/gdsfactory/gdsfactory)](https://choosealicense.com/licenses/mit/)
+
 # A-FMM
 
-Python Implementation of Aperiodic Fourier Modal Method for solving Maxwell equations.
+This is a Python implementation the Aperiodic-Fourier Modal Method, a fully vectorial method for solving Maxwell equations that combines a Fourier-based mode solver and a scattering matrix recursion algorithm to model full 3D structures. This approach is well suited to calculate modes, transmission, reflection, scattering and absorption of multi-layered structures. Moreover, support for Bloch modes of periodic structures allows for the simulation of photonic crystals or waveguide Bragg gratings.
+
+## Installation
+As for now, the advised way of installing is to just clone the repository and add it to your PYTHONPATH environment variable.
 
-### Documentation
-Full documentation can be found [Here](https://a-fmm.readthedocs.io)
+## Documentation
+Full documentation is available on [Read the Docs](https://a-fmm.readthedocs.io)
 
diff --git a/localdocs b/localdocs
@@ -1,4 +1,4 @@
 #!/bin/bash
-rm -r docs/*
+rm -r docs-build/*
 touch Docs/*.rst
-sphinx-build -b html Docs docs/
+sphinx-build -b html Docs docs-build/