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

Split the README and create TODO and PLAN files #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rjc
Copy link

@rjc rjc commented Apr 1, 2019

README is overly long and it'll only keep on growing.
Created separate TODO and PLAN files and move the relevant content there.

README is overly long and it'll only keep on growing.
Created separate TODO and PLAN files and move the relevant content there.
@@ -6,273 +6,3 @@ This is actually my second stab at it, so big blocks will land in place from my
first attempt. I'm trying again this year after reading more of "Programming
Rust" (Blandy, Orendorff).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we perhaps put a link here to the moved sections?

@wmanley
Copy link

wmanley commented Apr 2, 2019

For what it's worth I really like the README as it is. It immediately gives one a sense of the status of the project and the motivation for its existence. Had the README just consisted of

git-rs

Implementing git in rust for fun and education!

This is actually my second stab at it, so big blocks will land in place from my first attempt. I'm trying again this year after reading more of "Programming Rust" (Blandy, Orendorff).

I don't think the project would have caught my attention.

@rjc
Copy link
Author

rjc commented Apr 2, 2019

@wmanley I'm not claiming it should only contain that part - README certainly needs expanding. I'm merely proposing splitting it into files where the relevant information fits better, IMVHO.

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.

3 participants