Repository navigation
Add mission statement and other good things to the READMEÂ #148
Copy link
Copy link
Closed
7 / 77 of 7 issues completed
Copy link
Labels
organizationOrganizational taskOrganizational task
Description
Describe the task
We should update the existing README and add some things that were requested or are missing like:
- Short paragraph of what XLibre is
- Motivation/Reasons to fork
- Mission statement
- Project achievements so far (Top 3 or so)
- with screenshots where applicable
Links to the release notes in the mailing list- Link to the NEWS file containing a simple changelog
- Whatâs next
- Switching to XLibre reference
- only brief instructions
- postponed: Add directions on how to switch to XLibre xserver#210
- (Short) build instructions
- including supported platforms (or keep it separate?)
- link to the wiki for details
- Section about compatibility
- Mention API/ABI stability aspects
- Mention the dependency on the project provided drivers
- Mention efforts to ensure compatibilty with Nvidia driver
- Add a Compatibility page to the wiki xserver#436
Upgrade notices- Contributing section
- Call to action for driver testers
- postponed: Call to action for test engineers to create test cases
- postponed: Call to action for continious integration geeks
- Links to the existing packages and package related discussions
- Call to action for packagers
- Call for ideas (link to Discussions/Ideas)
- Call to action for "Show and Tell"
- Link to awesome lists?
- License?
- Outro
Maybe more, maybe less.
It should be done because
We should guide our users and potential contributors to the information listed aboves. This is the outcome of several discussions and issues which will get linked here.
Addtional Information
Please only comment on this issue if you have something new that is related to this topic and has not been said already.
Extra fields
- I have checked the existing issues
- I have read the Contributing Guidelines
- I'd like to work on this issue
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
organizationOrganizational taskOrganizational task
Activity
[-]# Add mission statement and other good things to the README[/-][+]Add mission statement and other good things to the README[/+]callmetango commentedon Jul 12, 2025
Blocked-by: #135
callmetango commentedon Jul 15, 2025
Blocked-by: #210
callmetango commentedon Jul 15, 2025
Blocked-by: #63
Blocked-by: #280
callmetango commentedon Jul 16, 2025
Blocked-by: X11Libre/xserver#210
README: add featured liberated screens
HISTORY.md: add brief overview of the XLibre fork
README.md: add mission statement and many more
HISTORY.md: add brief overview of the XLibre fork
README.md: add mission statement and many more