Giter VIP home page Giter VIP logo

Comments (9)

anthonylavado avatar anthonylavado commented on May 16, 2024 1

@JustAMan - I’ll talk with @joshuaboniface on this too, but would a statement, followed by “Read more” with a link to the wiki be good?

I’m just thinking ahead to people that might come across this, so I would want to have a nice quick page that briefly tells them about the project, and how to get started.

Admittedly I’m not a master at this. You can see a README for a project I help maintain: https://github.com/mike-grant/haaska/blob/master/README.md

Here’s a good example from a semi-popular template:
https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

from jellyfin.

JustAMan avatar JustAMan commented on May 16, 2024 1

I had a look at your readme and now I get your point. I think we can safely move "motivation" to wiki leaving a link in readme. Ideally it might just be a paragraph about what is this project plus a few links for further reading.

from jellyfin.

joshuaboniface avatar joshuaboniface commented on May 16, 2024 1

I agree, my essay doesn't need to be in the README 😆

from jellyfin.

anthonylavado avatar anthonylavado commented on May 16, 2024

I can work on at least the README. Ideally we’ll want to move a lot of it (the statements on why the project exists, etc) out to the Wiki. We’ll probably need to take out the screenshots too.

from jellyfin.

JustAMan avatar JustAMan commented on May 16, 2024

I think that motivation for the project should stay in the Readme along with what the project is about.
Screenshots definitely belong to a wiki page (linked to in the readme, though, so ppl would be able to find them easily).

from jellyfin.

anthonylavado avatar anthonylavado commented on May 16, 2024

Linking here: there is some work in #6

from jellyfin.

joshuaboniface avatar joshuaboniface commented on May 16, 2024

@nvllsvm 's PR #6 has been merged, which gets rid of the old Emby images and such from the README. I'm going to start splitting things out now to get the README condensed.

from jellyfin.

anthonylavado avatar anthonylavado commented on May 16, 2024

@joshuaboniface Don't know how far along you are, but here's a handy badge I found that you can use: https://matrix.to/img/matrix-badge.svg

from jellyfin.

joshuaboniface avatar joshuaboniface commented on May 16, 2024

Suplemented by practical action in #25

from jellyfin.

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.