-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cleanup unnecessary files #2030
Conversation
It is now covered by README.md and Wiki.
Install instructions are now on Wiki.
Personally I'm happy with this approach. I can't remember the last time I looked in a tarball for information, rather than at a project website or wiki. The files also need removing from the top-level --- a/Makefile.am
+++ b/Makefile.am
@@ -11,15 +11,8 @@ EXTRA_DIST = \
astyle_config.as \
bootstrap \
coding_style.md \
- description-pak \
- design.txt \
- faq-compile.txt \
- faq-general.txt \
- file-loc.txt \
fontdump \
- install.txt \
m4 \
- postinstall-pak \
vrplayer
if XRDP_NEUTRINORDP A couple of suggestions/questions:-
|
Ah, I forgot to edit Makefile.am. Thanks for the catch.
I think astyle_config.as is the master of the coding style and coding_style.md is a human-friendly translation of astyle_config.as. So it is a supplemental document but not strongly needed because we do coding style checks during CI now.
Yes, quick guide should be written in README.md but detailed information can be put on Wiki and linked from README.md. I personally think the "Compiling" section can be minimized and replaced with a link to Wiki. |
BTW, the filename of coding_style.md appears odd a bit for me. Because other markdown files are named uppercase. Personally, I would like to remove coding_style.md and add CONTRIBUTING.md for a quick guide of new contributions. Then I would like to mention running code formatter before making a pull request in that file. |
Agreed about the CONTRIBUTING.md. That's more useful I think than what we've got at the moment. |
Let's merge this and work on CONTRIBUTING.md later. |
Cleanup obsoleted, not up-to-date, not in-use files.
Most files are created in the SourceForge era. Now we are living GitHub era. Supplemental information can be provided by Wiki. If the deletion is too aggressive, please let me know.
To make it easier to revert, I separated deletion to multiple commits for each file.
debian/
directory for example if we add such files