Giter Club home page Giter Club logo

Comments (4)

ctmbl avatar ctmbl commented on August 20, 2024 2
  • in the files: a simple header with a string easy to grep or rg
  • in the directories, i.e. the items ending in "/" in the README, maybe a HEADER.txt or .header.txt file could do the trick
    something in that vein

I like that!

from iscsc.fr.

amtoine avatar amtoine commented on August 20, 2024

i see a few ideas to do so:

  1. add headers to the files and directories to be in the structure summary, each header would contain the description in the README and then parse them and the whole repo to generate the new structure in the README
  2. keep track of the repo structure and notify with a script when the structure changes, not the content of the files
  3. the same but in a strutured file, like TOML or JSON

these are very not mature ideas, but what comes to me when reading your issue 😋

from iscsc.fr.

ctmbl avatar ctmbl commented on August 20, 2024

I was going to propose something slightly less complete than @amtoine but I like this "header" idea, however, how do you add a header to a directory ??

A simple github action that parses the README and compare it to tree or ls on the repo should do the job I think! That looks like quite some thinking and work but doesn't seems impossible!

from iscsc.fr.

amtoine avatar amtoine commented on August 20, 2024

I was going to propose something slightly less complete than @amtoine but I like this "header" idea, however, how do you add a header to a directory ??

well 🤔

  • in the files: a simple header with a string easy to grep or rg
  • in the directories, i.e. the items ending in "/" in the README, maybe a HEADER.txt or .header.txt file could do the trick
    something in that vein 😋

A simple github action that parses the README and compare it to tree or ls on the repo should do the job I think! That looks like quite some thinking and work but doesn't seems impossible!

definitely something that could be usefull 👍
but that does not solve the issue with the descriptions 🤔
see above 😉

from iscsc.fr.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.