luong-komorebi / Begin-Latex-in-minutes

๐Ÿ“œ Brief Intro to LaTeX for beginners that helps you use LaTeX with ease.
https://luong-komorebi.github.io/Begin-Latex-in-minutes/
3.28k stars 269 forks source link

Split into multiple files to avoid complicated merges #23

Open vermiculus opened 8 years ago

vermiculus commented 8 years ago

We should consider splitting this document into multiple files to avoid complicated merges and allow for a clearer structure. I'd recommend a file structure like this:

/README.md                                ; actual summary of the project; annotated TOC
/guide/01-introduction-and-goals/README.md           ; introduction and goals
/guide/01-introduction-and-goals/image-for-ch1.png   ; some picture
/guide/02-your-first-document/REAMDE.md              ; first doc
...

Before I actually make the PR though, I'd like to nail down what the TOC should look like. This is what we have right now:

Here's what I'd propose:

luong-komorebi commented 8 years ago

@vermiculus I understood what you are trying to do. Actually, I thought about spliting files into small bits while I was brainstorming for this repo. However, I also wanted it to be concise for people to get on LaTeX as fast as possible so I chose not to split it. On the "complicated merges" problem, I didn't see that coming ๐Ÿ˜ข . So now, I am a little confused whether to split or not. Can you leave me sometimes to consider?

luong-komorebi commented 8 years ago

@vermiculus I agreed with you now. Sadly, my computer just broke last night. Will you help me splitting things up if I add you to the repo as a collab?

vermiculus commented 8 years ago

Can do.

luong-komorebi commented 8 years ago

@vermiculus Thank you. Invitation coming. Thank you.

If possible I would like to have a development branch so that we can discuss before pushing to the master branch ๐Ÿ‘ .
Thank you, again. I will get back ASAP when my laptop is ready back.

vermiculus commented 7 years ago

Why was this closed? Having open issues in a repository isn't a bad thing ๐Ÿ˜„

luong-komorebi commented 7 years ago

@vermiculus No haha it's absolutely fine to me. haha :smile: I closed this because I thought we wouldn't accomplish this anyway. I myself didn't have the time to expand or split it. I don't know how about you haha but a long time have passed ( nearly 3 weeks ) so I closed it

vermiculus commented 7 years ago

Sometimes many weeks go by until folks are able to get to issues ๐Ÿ˜„ most of this has to do with school / work schedule constraints. Issues trackers like GitHub's are made for just that: tracking would you'd like to do in a project. They're there so we don't forget ๐Ÿ˜‰

luong-komorebi commented 7 years ago

@vermiculus ๐Ÿ˜„ I totally understood now. Sorry for closing this issue weeks ago.

aaossa commented 7 years ago

So, will you split the README? I found this project a while ago and I was wondering if some translation work could be done too (I could translate it to Spanish, but it would take some time). I would like to help :grin:

Maybe a new issue for translation and adding a label for "Begginer friendly" could bring more collaborators :)

(Just an idea, I like to find projects to collaborate :grin: )

luong-komorebi commented 7 years ago

@aaossa Thank you but I think I wouldn't split that. I would like to keep it simple, lean and straightforward. The guide is not that complex that it needs modularizing. In the future, I may think of upgrade it, then I would definitely split this readme file. But for now, just keep it simple like that.

Translation is welcomed, I never say I would ban that (lol :rofl: )

bibbca commented 6 years ago

Maybe we should start people off with an online LaTeX editor like Overleaf, ShareLaTeX, or Papeeria?