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

Reorganise README #70

Closed
vkazanov opened this issue Jan 4, 2017 · 7 comments
Closed

Reorganise README #70

vkazanov opened this issue Jan 4, 2017 · 7 comments

Comments

@vkazanov
Copy link
Collaborator

vkazanov commented Jan 4, 2017

I've been using org-journal for quite a long time now. Recently I realised that it has a fancy new feature I really missed ("carry over", to be precise) mostly because current README is a bit messy.

How about cleaning things up a bit? I can do it myself in a PR if @bastibe agrees here with me.

@bastibe
Copy link
Owner

bastibe commented Jan 5, 2017

I would be grateful!

For reference, what things would you like to change?

Also, I grew to really love the carry over feature as well. It should definitely be featured more prominently in the README.

@vkazanov
Copy link
Collaborator Author

vkazanov commented Jan 5, 2017

Yeah, the carry over feature is awesome. I used to use plain checkboxes for my daily tasks but this thing forced me to use proper TODOs and stuff. The journal feels much cleaner and generally better now!

Theoretical structure of README (the order is important):

  1. Basic explanation of ideas behind org-journal.
  2. A short tutorial on installation and basic features of the project. Not covering advanced things (search, encryption, etc) yet.
  3. Caveats.
  4. Details on various features and implementation.

I also think separate CONTRIBUTORS and NEWS files might be reasonable.

The point is to present a project first, get the user up and running, answer his questions next.

What do you think?

@vkazanov
Copy link
Collaborator Author

vkazanov commented Jan 5, 2017

Oh, BTW, do you use the search feature? At some point I realised I use it as a way to build reports on things done, not done etc, but it's a bit lacking here.

So, I started wondering if some kind of a reporting framework might be interesting, similar to the org-mode agenda, but concentrating on the journal side of things.

@bastibe
Copy link
Owner

bastibe commented Jan 5, 2017

The outline looks very good! I guess the changelog could be moved to a separate file, too. I would like to keep the first two lines of the original README, since they attribute the original source.

I opened a new issue for the BTW (#71).

@vkazanov
Copy link
Collaborator Author

vkazanov commented Jan 5, 2017

Great, let's see what I can do here! I'll come up with a PR within a few days.

@vkazanov
Copy link
Collaborator Author

vkazanov commented Jan 5, 2017

One more thing. How about choosing a license..? :-) Personally I don't care but it's a good habit to be explicit about those things.

@bastibe
Copy link
Owner

bastibe commented Jan 6, 2017

Silly me, I have indeed forgotten to chose a license. Thank you for pointing that out.

If I remember correctly, this goes back to JournalMode not having a license except for

Feel free to use, modify and improve the code! - mtvoid

Keeping with the spirit of this line, I added a BSD 3-clause license file in 008ef45.

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

No branches or pull requests

2 participants