search

novoid / Memacs

What did I do on February 14th 2007? Visualize your (digital) life in Org-mode
GNU General Public License v3.0
1.03k stars 66 forks source link

Spring cleanup #39

Closed ghost closed 6 years ago

ghost commented 7 years ago

This cleanup aims to refresh memacs files and docs, which got obsolete over the years. I'm not sure what you think about, I tried not to change things without any reason.

First of all, I deleted all unnecessary files from tmp folder, including the ones that already got satisfied by (stable) memacs modules. The jpilot ideas got their own folder and the performance.org and issuetracking.org files moved to tmp to maintain a more consistent look across bin, docs, and memacs module folder. Though, I'm not sure about if the information in these files are still that relevant these days.

All module docs now contain an Options section with all the custom arguments to invoke them with. I've moved the FAQs_and_Best_Practices out of the docs folder to the top level. I've also removed the execution bit of files in the memacs modules folder, that's what we've the bin folder for.

The .gitignore file got really... ugly 🤣 most of the ignored files and folders in there make no sense to me. I guess you put them in there as your local memacs folder may look quite different. I think you'd do better using a private excludes file instead. To make things save, I've included *.org_archive, *error.org* and tmp/**/*.xml into it to make sure, there won't be any personal data in the repo by accident.

Last but not least, I've updated the README.org with some more structure, a table of contents and an example image I made with ditaa. The memacs modules section consists now of a simple alphabetical list with links to the docs instead of p(l)ain see docs/... references. The INSTALL.org file is gone. The important sections moved to the Installation and Getting started section of the readme as well.

You can see a preview here.

novoid commented 7 years ago

I am very sorry that it took me that long to take a look at this - meanwhile - autumn cleanup ;-)

Most of the things are perfectly fine to me. However, you did remove too many things that are - unfortunately - relevant to me. I've got no time to migrate my setup for now to support the more modern modules.

I could not find out if I am able to apply commit partly therefore I can't apply your set of commits for now.

novoid commented 6 years ago

Thanks @Glumanda99 for your contribution! I applied most changes from this huge pull request manually. Since I could not find out how to split up your commits into smaller things I could decide to apply or to reject some changes got my contribution instead of yours. Sorry for that :-(