path: root/README
AgeCommit message (Collapse)Author
2016-02-25README: use markdown syntaxMatthieu Moy
This allows repository browsers like GitHub to display the content of the file nicely formatted. Signed-off-by: Matthieu Moy <> Signed-off-by: Junio C Hamano <>
2014-10-10doc: add 'everyday' to 'git help'Philip Oakley
The "Everyday GIT With 20 Commands Or So" is not accessible via the Git help system. Move everyday.txt to giteveryday.txt so that "git help everyday" works, and create a new placeholder file everyday.html to refer people who follow existing URLs to the updated location. giteveryday.txt now formats well with AsciiDoc as a man page and refreshed content to a more command modern style. Add 'everyday' to the help --guides list and update git(1) and 5 other links to giteveryday. Signed-off-by: Philip Oakley <> Signed-off-by: Junio C Hamano <>
2013-02-06Merge branch 'ta/doc-no-small-caps'Junio C Hamano
Update documentation to change "GIT" which was a poor-man's small caps to "Git". The latter was the intended spelling. Also change "git" spelled in all-lowercase to "Git" when it refers to the system as the whole or the concept it embodies, as opposed to the command the end users would type. * ta/doc-no-small-caps: Documentation: StGit is the right spelling, not StGIT Documentation: describe the "repository" in repository-layout Documentation: add a description for 'gitfile' to glossary Documentation: do not use undefined terms git-dir and git-file Documentation: the name of the system is 'Git', not 'git' Documentation: avoid poor-man's small caps GIT
2013-02-01Documentation: avoid poor-man's small caps GITThomas Ackermann
In the earlier days, we used to spell the name of the system as GIT, to simulate as if it were typeset with capital G and IT in small caps. Later we stopped doing so at around 1.6.5 days. Let's stop doing so throughout the documentation. The name to refer to the whole system (and the concept it embodies) is "Git"; the command end-users type is "git". And document this in the coding guideline. Signed-off-by: Thomas Ackermann <> Signed-off-by: Junio C Hamano <>
2013-01-29README: update stale and/or incorrect informationJunio C Hamano
Ramkumar Ramachandra noticed that the old address for the marc archive no longer works. Update it to its address, and also refer to the gmane site. Remove the reference to "note from the maintainer", which is not usually followed by any useful discussion on status, direction nor tasks. Also replace the reference to "What's in git.git" with "What's cooking". Signed-off-by: Junio C Hamano <>
2012-12-16README: it does not matter who the current maintainer isJunio C Hamano
The audience of this introductory document does not have to know nor interact with the maintainer, so drop the mention of him. Other documents such as SubmittingPatches may be a more suitable place to have it. Signed-off-by: Junio C Hamano <>
2012-12-16README: Git is released under the GPLv2, not just "the GPL"Stefano Lattarini
And this is clearly stressed by Linus in the COPYING file. So make it clear in the README as well, to avoid possible misunderstandings. Signed-off-by: Stefano Lattarini <> Signed-off-by: Junio C Hamano <>
2012-02-23README: point to Documentation/SubmittingPatchesMatthieu Moy
It was indeed not obvious for new contributors to find this document in the source tree, since there were no reference to it outside the Documentation/ directory. Signed-off-by: Matthieu Moy <> Signed-off-by: Junio C Hamano <>
2009-10-07README: git lives at these daysStefan Naewe
Signed-off-by: Stefan Naewe <> Signed-off-by: Junio C Hamano <>
2009-02-25README: fix path to "gitcvs-migration.txt" and be more consistentChristian Couder
README suggested to look at "Documentation/gittutorial.txt" for the tutorial and to use "man git-commandname" for documentation of each command. This was not consistent because the tutorial can also be available with "man gittutorial" once git is installed, and the documentation for each command can be available at "Documentation/git-commandname.txt" before installing git. This patch tries to make the description more consistent. It also fixes the path to the cvs-migration documentation that changed from "Documentation/cvs-migration.txt" to "Documentation/gitcvs-migration.txt". Signed-off-by: Christian Couder <> Signed-off-by: Junio C Hamano <>
2009-01-07README: tutorial.txt is now called gittutorial.txtJoey Hess
Signed-off-by: Joey Hess <> Signed-off-by: Junio C Hamano <>
2007-03-26Update README to point at a few key periodical messages to the listJunio C Hamano
They give a good starting point to new people who want to get involved. This owes suggestions by Martin Langhoff and Steven Grimm. Signed-off-by: Junio C Hamano <>
2007-01-17sanitize content of README fileNicolas Pitre
Current README content is way too esoteric for someone looking at GIT for the first time. Instead it should provide a quick summary of what GIT is with a few pointers to other resources. The bulk of the previous README content is moved to Documentation/core-intro.txt. Signed-off-by: Nicolas Pitre <> Signed-off-by: Junio C Hamano <>
2005-12-08Documentation: git.html/git.7Junio C Hamano
Finish each sentence with a full stop. Instead of saying 'directory index' 'directory cache' etc, consistently say 'index'. Signed-off-by: Junio C Hamano <>
2005-11-15Documentation: do not blindly run 'cat' .git/HEAD, or echo into it.Junio C Hamano
Many places in the documentation we still talked about reading what commit is recorded in .git/HEAD or writing the new head information into it, both assuming .git/HEAD is a symlink. That is not necessarily so. Signed-off-by: Junio C Hamano <>
2005-11-03Illustration: "Fundamental Git Index Operations"Junio C Hamano
Jon Loeliger's ASCII art in the Discussion section. Signed-off-by: Junio C Hamano <>
2005-09-20[PATCH] Documentation: Update all files to use the new gitlink: macroSergey Vlasov
The replacement was performed automatically by these commands: perl -pi -e 's/link:(git.+)\.html\[\1\]/gitlink:$1\[1\]/g' \ README Documentation/*.txt perl -pi -e 's/link:git\.html\[git\]/gitlink:git\[7\]/g' \ README Documentation/*.txt Signed-off-by: Sergey Vlasov <> Signed-off-by: Junio C Hamano <>
2005-09-08Big tool rename.Junio C Hamano
As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano <>
2005-08-30Documentaion updates.Junio C Hamano
Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit)
2005-08-17[PATCH] use it's and its correctly in documentationGreg Louis
At one place in Documentation/tutorial.txt and several in the base README, its was wrongly used in place of it's or vice versa. One instance remains somewhere in Documentation/howto/, which I didn't correct because it's in a quotation. Signed-off-by: Greg Louis <> Signed-off-by: Junio C Hamano <>
2005-07-09[PATCH] Expose object ID computation functions.Bryan Larsen
This patch makes the first half of write_sha1_file() and index_fd() externally visible, to allow callers to compute the object ID without actually storing it in the object database. [JC demangled the whitespaces himself because he liked the patch so much, and reworked the interface to index_fd() slightly, taking suggestion from Linus and of his own.] Signed-off-by: Bryan Larsen <> Signed-off-by: Junio C Hamano <> Signed-off-by: Linus Torvalds <>
2005-06-27[PATCH] Remove "delta" object representation.Junio C Hamano
Packed delta files created by git-pack-objects seems to be the way to go, and existing "delta" object handling code has exposed the object representation details to too many places. Remove it while we refactor code to come up with a proper interface in sha1_file.c. Signed-off-by: Junio C Hamano <> Signed-off-by: Linus Torvalds <>
2005-05-22[PATCH] Docs - delta objectDavid Greaves
Added delta documentation Signed-off-by: David Greaves <> Signed-off-by: Linus Torvalds <>
2005-05-22[PATCH] Docs - tag object, git- prefix and s/changeset/commit/gDavid Greaves
Add docs for tag type Rename commands to have git- prefix Rename changeset to commit throughout Signed-off-by: David Greaves <> Signed-off-by: Linus Torvalds <>
2005-05-22[PATCH] Docs - asciidoc changesDavid Greaves
Whitespace and asciidoc formatting changes only in preparation for content changes. Signed-off-by: David Greaves <> Signed-off-by: Linus Torvalds <>
2005-05-11More README spelling fixesPetr Baudis
Two other README spelling fixes. I wasn't able to pinpoint the relevant commit in the cogito branch, but they are fairly trivial anyway.
2005-05-11Spelling fixes in README.Zack Brown
Signed-off-by: Zack Brown <> Signed-off-by: Petr Baudis <>
2005-05-11[PATCH] Misc fixes for git-paskyPavel Roskin
* README: spell checked Signed-off-by: Pavel Roskin <> Few more s/ie/i.e./ fixes. Signed-off-by: Petr Baudis <>
2005-05-10Rename environment variables.Junio C Hamano
H. Peter Anvin mentioned that using SHA1_whatever as an environment variable name is not nice and we should instead use names starting with "GIT_" prefix to avoid conflicts. Here is what this patch does: * Renames the following environment variables: New name Old Name GIT_AUTHOR_DATE AUTHOR_DATE GIT_AUTHOR_EMAIL AUTHOR_EMAIL GIT_AUTHOR_NAME AUTHOR_NAME GIT_COMMITTER_EMAIL COMMIT_AUTHOR_EMAIL GIT_COMMITTER_NAME COMMIT_AUTHOR_NAME GIT_ALTERNATE_OBJECT_DIRECTORIES SHA1_FILE_DIRECTORIES GIT_OBJECT_DIRECTORY SHA1_FILE_DIRECTORY * Introduces a compatibility macro, gitenv(), which does an getenv() and if it fails calls gitenv_bc(), which in turn picks up the value from old name while giving a warning about using an old name. * Changes all users of the environment variable to fetch environment variable with the new name using gitenv(). * Updates the documentation and scripts shipped with Linus GIT distribution. The transition plan is as follows: * We will keep the backward compatibility list used by gitenv() for now, so the current scripts and user environments continue to work as before. The users will get warnings when they have old name but not new name in their environment to the stderr. * The Porcelain layers should start using new names. However, just in case it ends up calling old Plumbing layer implementation, they should also export old names, taking values from the corresponding new names, during the transition period. * After a transition period, we would drop the compatibility support and drop gitenv(). Revert the callers to directly call getenv() but keep using the new names. The last part is probably optional and the transition duration needs to be set to a reasonable value. Signed-off-by: Junio C Hamano <>
2005-04-18Update README to reflect the hierarchical tree objects,Linus Torvalds
and other newfangled things like merging. Also, talk more about the actual operations, and give some rough examples of what you can do.
2005-04-11Rename ".dircache" directory to ".git"Linus Torvalds
I started out calling the tool "dircache". That's clearly moronic.
2005-04-07Initial revision of "git", the information manager from hellLinus Torvalds