Beliavsky / Fortran-code-on-GitHub

Directory of Fortran codes on GitHub, arranged by topic
The Unlicense
277 stars 54 forks source link

README.md is too long, entries at the bottom do not appear #52

Closed Beliavsky closed 4 months ago

Beliavsky commented 4 months ago

For example the Unit Testing and XML categories are missing. I could split the list in two, leaving the numerical methods and other algorithms categories on the main README.md and putting the domain-specific categories on a different page. The main page would have

Benchmarks Code Tools Compiler Tests Containers and Generic Programming Cryptography Databases Dates and Times Error Handling Expression Parsers Fast Fourier Transform File I/O Finite Elements Fortran Books and Tutorials Graphics, Plotting and User Interfaces General Purpose Interoperability Interpolation Linear Algebra Mesh Generation Neural Networks and Machine Learning Numerical Numerical Integration (Quadrature) Ordinary Differential Equations Optimization Parallel Programming Partial Differential Equations Random Number Generation Reactor Physics Regular Expressions Quantum Chemistry and Electronic Structure Sorting Statistics Strings Time Series Unclassified Unit Testing Web Programming XML

and the domain-specific page would have

Art and Music Astronomy and Astrophysics Biology and Medicine Climate and Weather Computational Chemistry Computational Fluid Dynamics Earth Science Economics Engineering Games Materials Science Molecular Dynamics Particle Physics Physics Plasma Physics

vmagnin commented 4 months ago

I think the user can search into that list:

Splitting the README.md file into several files would not impede the first method. But the second one would become far less interesting (probably one day you will need three or four pages). The user could also use the GitHub search field to search in the repository but it needs too many clicks to be usable.

You could also explore other functionalities offered by GitHub:

vmagnin commented 4 months ago

Note also that if you click on the README.md file, it is opened fully, up to the XML section (and I can use my preferred CTRL+F method).

It means the size limit concerns only the README of the main GitHub page.

Beliavsky commented 4 months ago

Note also that if you click on the README.md file, it is opened fully, up to the XML section (and I can use my preferred CTRL+F method).

It means the size limit concerns only the README of the main GitHub page.

Thanks. I will mention this the next time I post an update on Fortran Discourse. For now I will keep the entries in a single file.

vmagnin commented 4 months ago

You can also give the direct link: https://github.com/Beliavsky/Fortran-code-on-GitHub/blob/main/README.md instead of: https://github.com/Beliavsky/Fortran-code-on-GitHub

vmagnin commented 4 months ago

And on that page there is a useful icon to download easily the .md file.