Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the README #332

Closed
5 tasks done
Ludee opened this issue Aug 18, 2022 · 3 comments · Fixed by #354
Closed
5 tasks done

Update the README #332

Ludee opened this issue Aug 18, 2022 · 3 comments · Fixed by #354
Assignees
@Ludee
Labels
📖 documentation Improvements or additions to documentation 👐 help wanted Extra attention is needed

Comments

@Ludee
Copy link
Member

Ludee commented Aug 18, 2022 •
edited
Loading

  • Switch from .MD to .RST to allow easier formatting
  • Update license identifier
  • Include link to PyPi and Zenodo
  • Add more badges
  • Add and align images
@Ludee Ludee added 📖 documentation Improvements or additions to documentation 👐 help wanted Extra attention is needed labels Aug 18, 2022
@Ludee Ludee self-assigned this Aug 18, 2022
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Rename README.rst #332
73d6ae8
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Update badges #332
ab0ec82
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix table #332
676d243
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix badges #332
10d329c
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix badges #332
5005fe3
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
FIx rtd badge #332
4c2597d
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Update links #332
2129a30
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Rewrite installation section in rst #332
19bfc4f
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Reduce code #332
bf7bcff
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix image #332
8b0fb41
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix svg #332
bcb505e
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix header #332
2967e1f
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix table #332
b23fedc
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Add data license #332
1bbe0d1
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Use images with raw html #332
ea39436
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Not working on GitHub #332
5b85869
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Try #332
472ea96
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Another try #332
950b7dc
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
last try #332
e5a4ddf
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Github hates rst images #332
97e492f
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Align #332
3238653
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Remove second bar #332
adf3eb6
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix heading #332
f1c3520
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Crazy bugs #332
2ef0d55
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Crashed again #332
76810f2
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Test linked image #332
e865947
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Format images below heading #332
5a7e35c
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Fix heading #332
0dc64a1
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Lines do not work with images #332
a46d676
Ludee added a commit that referenced this issue Aug 18, 2022
@Ludee
Aligne images not possible #332
27eeb9f
@Ludee
Copy link
Member Author

Ludee commented Aug 18, 2022

Aligne images on top of a RST file is not possible.
The workaround with raw html only works with one image:
github/markup#163

Other related sites:
https://stackoverflow.com/questions/63296956/image-above-title-github-readme-rst
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/images.html

Create one large image with logos and include!

@FlorianK13
Copy link
Member

Looks very nice already.
Can you also add the monthly downloads badge?

|PyPI download month|

.. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads
:target: https://pypi.org/project/open-mastr/

@Ludee Ludee changed the title Update the README.md Update the README Aug 23, 2022
FlorianK13 added a commit that referenced this issue Oct 25, 2022
@FlorianK13
Add pypi downloads badge #332
4392ff0
@chrwm chrwm mentioned this issue Oct 26, 2022
Merged
@Ludee
Copy link
Member Author

Ludee commented Oct 31, 2022

MaStR_Readme_Logo

Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Add logos #332
047d6f0
Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Fix logo #332
c5a542f
Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Wont fix #332
bf91276
Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Fix the BOM #332
344107e
Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Update read README.rst #332
a90b4da
@Ludee Ludee linked a pull request Oct 31, 2022 that will close this issue
Update README #354
Merged
Ludee added a commit that referenced this issue Oct 31, 2022
@Ludee
Update Changelog #332
e6641b7
@Ludee Ludee closed this as completed Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Ludee Ludee

Labels
📖 documentation Improvements or additions to documentation 👐 help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README OpenEnergyPlatform/open-MaStR
2 participants
@Ludee @FlorianK13