diff --git a/README.md b/README.md index 0dd0ec11ce1861e14d5188f77bf426bb9b1c27e5..347d019970ab6a9e18968f96fec55d8d78414dce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,96 @@ # Introduction -This Markdown Specification project implements an example of a structure to store and collaborate on a 3GPP specification in a git repository. The base version of the specification is v18.0.0 of TS38.331. The example recreates the RILs for the UAV work item starting in RAN2#125. The RILs are named as they were in that reivew, the review file for which can be found linked below in the resources section. The RILs were recreated to closely match their corresponding edits to the frozen specification, as if each RIL were submitted with text proposals for changes. The RILs were then implemented through merges and merge conflict resolution. +This Markdown Specification project implements an example of a structure to store and collaborate on a 3GPP specification in a git repository. The base version of the specification is v18.0.0 of TS38.331. The example recreates the RILs for the UAV work item starting in RAN2#125. The RILs are named as they were in that review, the review file for which can be found linked below in the resources section. The RILs were recreated to closely match their corresponding edits to the frozen specification, as if each RIL were submitted with text proposals for changes. The RILs were then implemented through merges and merge conflict resolution. + +# Git +To get started with the basics of Git, it is recommended to read the [documentation](https://git-scm.com/book/en/v2). The most important sections to check are "Getting Started" and "Git Basics". For most, the following Git commands will be the most useful. + +| Command | Function | +|----|----| +| git status | Print the status of the files in the git repository. Staged (added for commit) and unstaged files will be listed. This view is a good way to verify that all the intended files have been added prior to committing changes to ETSI Forge. | +| git branch | Print all of the branch names associated with the repository. Add -v, i.e., git branch -v, to show the latest commit message for each branch. | +| git checkout \ | Switch to branch `` | +| git checkout -b \ | Create a branch `` and swich to it. | +| git add | Add a file to the staging area for committing to the repository. It is best practice to specify each file separately. Never try to use the -a flag to add everything at once. | +| git commit | Commit staged (added) files to the repository. Without arguments, a text editor will launch where a commit message can be written. | +| git commit -t