juanrapha/notes — pull request #1 by cirosantilli (2013-04-22 07:15:46+00:00)
Title: basic suggestions

hi, this is a pull request, I'm asking you to accept some changes I've made! =)

if you disagree with any of those suggestions, tell me, and I will undo them so you like my pull request. It's your repo after all!

# output files

don't add output files to git like .pdf or .log. Add them to your .gitignore and git will never look at them.

Only publish a few stable versions of pdfs, (1.0, 1.1, 1.2 etc) or else:

- you are going to clutter your repo too much
- they might contain bugs.

I still don't konw what is the best way to publish those, but a common way is making a project website/ personal website. Don't forget to link to your github from there so people can help!

# use a makefile

automate builds in an editor independant way. This is my current latex makefile, modify it at will.

# dirnames

name directories without spaces, replacing spaces either with hyphen '-' or '_'. I prefer hyphen since it looks nicer and is more popular on urls today.

# symlinks

git keeps symlinks =). so use a single makefile per repo and symlink away.

An even better option is using submodules so you can share your files across repos! but you can learn this a bit later.

# readme.md

I add extension to the .md. This is optional, but it is a good practice to give an extension to every file so others can know the format easily. Markdown is my favourite format for readmes now, and github is smart with markdown.