Comments (9)
@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.
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.
I agree, my essay doesn't need to be in the README 😆
from jellyfin.
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.
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.
Linking here: there is some work in #6
from jellyfin.
@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.
@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.
Suplemented by practical action in #25
from jellyfin.
Related Issues (20)
- [Issue]: 404 on update HOT 8
- stack traces and playback errors after upgrade to 10.9.0 HOT 5
- [Issue] The WebRootPath was not found: /var/lib/jellyfin/wwwroot. Static files may be unavailable. HOT 2
- [Issue]: Downgrade from 10.9.0 back to 10.8.13 does not work HOT 3
- Cannot access Jellyfin after updating to 10.9 - possible binding problem HOT 23
- [Issue]: Generate Trickplay Images Does Not Work HOT 6
- [Issue]: 10.9.0 - RAM keeps steadily increasing HOT 6
- [Issue]: Unable to play hardlinked files that are still seeding (unless seeding is paused) HOT 2
- [Issue]: After updating to 10.9.0, the live TV feature has a failure to play error HOT 4
- [Issue]: reboot via ui spams errors HOT 3
- [Issue]: Trickplay image generation failing HOT 3
- [Issue]: Docker network_mode: "host" binding problem HOT 13
- [Issue]: Missing playlists after 10.9.0 update HOT 5
- [Issue]: How long should Tickplay generation should take? HOT 5
- [Issue]: Cannot add Shows library on v10.9.0 HOT 2
- [Issue]: HOT 2
- [Issue]: [10.9.0] An unhandled exception was thrown by the application HOT 20
- AutoDiscoveryHost still returns wrong address HOT 8
- [Issue]: Video fast forwarding causes player stuck and wait until app restart on webOS
- [Issue]: [10.9] Resuming playback results in video (and subtitles) being out of sync HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jellyfin.