Skip to content
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

Merged
merged 7 commits into from
Oct 26, 2021
Merged

Cleanup unnecessary files #2030

merged 7 commits into from
Oct 26, 2021

Conversation

metalefty
Copy link
Member

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.

  • design.txt
    • not updated, Architecture Overview on the wiki covers it
  • file-loc.txt
    • not updated
  • faq-compile.txt
    • covered by Wiki
  • faq-general.txt
    • (will) covered by Wiki
  • install.txt
    • not updated, covered by Wiki
  • *-pak
    • created for packaging but not used actually by distro
    • we should create debian/ directory for example if we add such files

@matt335672
Copy link
Member

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 Makefile.am to fix the CI build:-

--- 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:-

  • How about coding_style.md?
  • Is it worth adding a link to the Wiki to README.md?

@metalefty
Copy link
Member Author

Ah, I forgot to edit Makefile.am. Thanks for the catch.

How about coding_style.md?

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.

Is it worth adding a link to the Wiki to README.md?

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.

@metalefty
Copy link
Member Author

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.

@matt335672
Copy link
Member

Agreed about the CONTRIBUTING.md. That's more useful I think than what we've got at the moment.

@metalefty
Copy link
Member Author

Let's merge this and work on CONTRIBUTING.md later.

@matt335672 matt335672 merged commit dd2336f into neutrinolabs:devel Oct 26, 2021
@metalefty metalefty deleted the cleanup branch October 26, 2021 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants