You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-15Lines changed: 49 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,10 +19,55 @@ Usability
19
19
Cost Effective
20
20
* Reusable 'generalised' code will increase efficient in creating higher level processes.
21
21
22
-
## Usage
23
-
codonPython is open to contributions and developments from new and experience users. Below is information about; best practices when using Github, contributing code and useful information for new users.
22
+
## Usage and Best Practices
23
+
codonPython is open to contributions and developments from new and experience users. Below is information about best practices when using Github, contributing code and useful information for new users.
24
24
25
-
### New to GitHub?
25
+
### Instillation
26
+
Clone a local repository to your machine from the remote repository using GitBash/Command Line.
27
+
```r
28
+
$cd<landing_folder_for_local_repo>
29
+
```
30
+
1.`$ cd` - Entered into GitBash changes the directory to desired landing folder.
2. Copy/Paste the above into GitBash to clone repo to your local machine.
35
+
```r
36
+
$cd<local_repo_name>
37
+
```
38
+
3. Change the root to the local repository.
39
+
40
+
### Checkout a branch using command line
41
+
Once the repository has been cloned to your local machine complete the following steps to navigate the branches.
42
+
```r
43
+
$gitbranch-a
44
+
```
45
+
1. List all the available branches
46
+
```r
47
+
*master
48
+
remotes/origin/<feature_branch_1>
49
+
remotes/origin/master
50
+
remotes/origin/<feature_branch_2>
51
+
```
52
+
All availabe branches will be listed. Using the branch names as a reference to navigate and checkout the desired branch.
53
+
```r
54
+
$gitcheckout<feature_branch>
55
+
```
56
+
2. Checkout the branch that you want to use.
57
+
```r
58
+
$gitcheckout-b<feature_branch>
59
+
```
60
+
3. Can also create a new branch if required.
61
+
```r
62
+
$gitbranch
63
+
```
64
+
4. To confirm you are working on the correct branch.
65
+
66
+
### Contributing to codonPython
67
+
68
+
Click [here](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
69
+
70
+
## New to GitHub?
26
71
27
72
GitHub is a hosting site that allows for development and version control of software using Git. It allows users to take a piece of code ( a branch) edit/develop it and submit it back to the owner to the original copy ( the master branch), whilst keeping track of all changes that have been made along the way.
28
73
@@ -44,15 +89,4 @@ Command Line
44
89
45
90
1.6 [Cloning Repo and Push/Pull](https://www.youtube.com/watch?v=yXT1ElMEkW8)
46
91
47
-
1.7 [Git Init and Git Add](https://www.youtube.com/watch?v=9p2d-CuVlgc)
48
-
49
-
### Contributing to codonPython
50
-
51
-
Click [here](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
52
-
53
-
## Installation
54
-
The package can be directly installed by typing in your terminal:
0 commit comments