Update package info on GSoC.

这个提交包含在:
Craig Warren
2019-04-01 12:41:03 +01:00
父节点 bf93651dcb
当前提交 b224a60f02

查看文件

@@ -40,7 +40,7 @@ Package overview
CONTRIBUTORS
docs/
gprMax/
gsoc-ideas.md
gsoc/
LICENSE
README.rst
setup.cfg
@@ -55,7 +55,7 @@ Package overview
* ``CONTRIBUTORS`` contains a list of names of people who have contributed to the gprMax codebase.
* ``docs`` contains source files for the User Guide. The User Guide is written using `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ markup, and is built using `Sphinx <http://sphinx-doc.org>`_ and `Read the Docs <https://readthedocs.org>`_.
* ``gprMax`` is the main package. Within this package the main module is ``gprMax.py``
* ``gsoc-ideas.md`` is a list of potential project ideas for `Google Summer of Code <https://summerofcode.withgoogle.com>`_ program
* ``gsoc`` contains information for `Google Summer of Code <https://summerofcode.withgoogle.com>`_ program - project ideas and proposal guidance.
* ``LICENSE`` contains information on the `GNU General Public License v3 or higher <http://www.gnu.org/copyleft/gpl.html>`_.
* ``README.rst`` contains getting started information on installation, usage, and new features/changes.
* ``setup.cfg`` is used to set preference for code formatting/styling using flake8.