FEAT: modernize README (#1543)

The goal of this pull-request is to fix #610. However, I decided to go one step further and update as much as possible our `README.md` file by: - [x] Using the `svg` logo as the banner image for the repository. It appears now as a centered image. - [x] Transpose the metadata table and add a `Maintainers` header pointing to a new `AUTHORS.md` file. - [x] Replace the molniya plot by a nice collage of examples. - [x] Enhanced the installation guide with a table covering conda, pypi and source installation. - [x] Add a table in the `Examples, background and talks` pointing to our talks in conferences. - [x] Updated license copyright years. Everything is pure markdown, which esures that PyPI will render properly. Please, take a look to: https://github.com/jorgepiloto/poliastro/tree/fix/molniya-plot Before I fix the link to the image for the collage of examples when merging.
poliastro · Feb 18, 2023 · 6e52a7c · 6e52a7c
2 parents dc22808 a6b9e62
commit 6e52a7c
Show file tree

Hide file tree

Showing 8 changed files with 210 additions and 137 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -0,0  1,11 @@
 # Authors
 
 Originally devised and implemented by [Juan Luis Cano Rodríguez](mailto:[email protected]).
 
 
 # Maintainers
 
 poliastro is maintained thanks to:
 
 * [Juan Luis Cano Rodríguez](mailto:[email protected])
 * [Jorge Martinez Garrido](mailto:[email protected])
diff --git a/COPYING b/COPYING
@@ -1,6  1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2021 Juan Luis Cano Rodríguez and the poliastro development team
 Copyright (c) 2012 Juan Luis Cano Rodríguez, Jorge Martínez Garrido, and the poliastro development team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
diff --git a/docs/source/_static/examples.png b/docs/source/_static/examples.png
diff --git a/docs/source/_static/logo_readme.png b/docs/source/_static/logo_readme.png
diff --git a/docs/source/_static/molniya.png b/docs/source/_static/molniya.png
diff --git a/docs/source/examples/molniya.png b/docs/source/examples/molniya.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,6  14,10 @@ license = {file = "COPYING"}
 authors = [
     {name = "Juan Luis Cano Rodríguez", email = "[email protected]"}
 ]
 maintainers = [
     {name = "Juan Luis Cano Rodríguez", email = "[email protected]"},
     {name = "Jorge Martinez Garrido", email = "[email protected]"}
 ]
 keywords = [
     "aero",
     "aerospace",