Skip to content

Update README.md #577

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.

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

Merged
merged 26 commits into from
Mar 8, 2021
Merged

Update README.md #577

merged 26 commits into from
Mar 8, 2021

Conversation

javoha
Copy link
Member

@javoha javoha commented Mar 2, 2021

Ready to merge.

Description

Please include a summary of the changes.

Relates to

Checklist

  • My code follows the PEP 8 style guidelines.
  • My code uses type hinting for function and method arguments and return values.
  • My code contains descriptive and helpful docstrings
    which are formatted per the Google Python Style Guidelines.
  • I have created tests which entirely cover my code.
  • The test code either 1. demonstrates at least one valuable use case (e.g. integration tests)
    or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).
  • New and existing tests pass locally with my changes.

Still to do:
- change logo
- choose and add iamges for header
- add papers 
- add more images at bottom?
@javoha javoha linked an issue Mar 2, 2021 that may be closed by this pull request
@javoha javoha marked this pull request as draft March 2, 2021 11:14
javoha and others added 25 commits March 2, 2021 12:27
- rewrite resources section
- added simple geometry examples in tile view at bottom
- new logo
- switched to png logo, svg file looks wrong
- added Fabians Paper
Added references and links to pdfs
Trying different layout of figures at top
It seems to be impossible to remove the table-border in markdown - quite a pain, so better as it was before.
- renamed example section to gallery
- used iamges without input data
- added reference links directly to models in documentation - images now clickable
[DOC] Gallery update: Features and Case studies
@javoha javoha marked this pull request as ready for review March 4, 2021 13:11
Copy link
Member

@flohorovicic flohorovicic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice restructuring of readme page - now clean and easy to find links to documentation and examples - great work, @javoha !

Copy link
Member

@flohorovicic flohorovicic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(and I would be happy to approve it ;-) )

@Leguark Leguark merged commit 8733917 into master Mar 8, 2021
@AlexanderJuestel AlexanderJuestel deleted the WIP_readme-update-march21 branch July 26, 2023 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Readme
3 participants