Skip to content

Commit 735f943

Browse files
Liam Fleming-NicolLiam Fleming-Nicol
authored andcommitted
updated read me
1 parent c2b695a commit 735f943

File tree

1 file changed

+49
-15
lines changed

1 file changed

+49
-15
lines changed

README.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,55 @@ Usability
1919
Cost Effective
2020
* Reusable 'generalised' code will increase efficient in creating higher level processes.
2121

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.
2424

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.
31+
```r
32+
$ git clone "https://github.com/codonlibrary/codonPython.git"
33+
```
34+
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+
$ git branch -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+
$ git checkout <feature_branch>
55+
```
56+
2. Checkout the branch that you want to use.
57+
```r
58+
$ git checkout -b <feature_branch>
59+
```
60+
3. Can also create a new branch if required.
61+
```r
62+
$ git branch
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?
2671

2772
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.
2873

@@ -44,15 +89,4 @@ Command Line
4489

4590
1.6 [Cloning Repo and Push/Pull](https://www.youtube.com/watch?v=yXT1ElMEkW8)
4691

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:
55-
```r
56-
python -m pip install --user git+https://github.com/codonlibrary/codonPython.git
57-
58-
```
92+
1.7 [Git Init and Git Add](https://www.youtube.com/watch?v=9p2d-CuVlgc)

0 commit comments

Comments
 (0)