Skip to content

Commit 997ce51

Browse files
authored
Updates to new ReadMe
1 parent 735f943 commit 997ce51

File tree

1 file changed

+31
-37
lines changed

1 file changed

+31
-37
lines changed

README.md

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -40,53 +40,47 @@ $ cd <local_repo_name>
4040
### Checkout a branch using command line
4141
Once the repository has been cloned to your local machine complete the following steps to navigate the branches.
4242
```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.
43+
# codonPython
6544

66-
### Contributing to codonPython
45+
[![Build Status](https://travis-ci.com/codonlibrary/codonPython.svg?branch=master)](https://travis-ci.com/codonlibrary/codonPython)
46+
[![codecov](https://codecov.io/gh/codonlibrary/codonPython/branch/master/graph/badge.svg)](https://codecov.io/gh/codonlibrary/codonPython)
6747

68-
Click [here](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
48+
`codonPython` will reduce the entry barrier for analysis and provide software development experience for those at a higher level of technical ability.
6949

70-
## New to GitHub?
50+
## What is `codon`?
7151

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.
52+
`Codon` is a project working towards creating a code repository to increase code sharing, consistancy and collaboration. The repository contains Python, R and SQL code for ease of use in workflows on platforms such as data bricks. Further information can be found [here.](https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing)
7353

74-
[The Git and Github for Poets](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6ZF9C0YMKuns9sLDzK6zoiV) is a useful series on Git and Github basics for beginner, that cover topics such as;
54+
#### Why `codon`?
55+
**Transparency**: To aline with government data principles and build public trust.
7556

76-
GitHub Basics
77-
78-
1.1 [Introduction to GitHub](https://www.youtube.com/watch?v=BCQHnlnPusY)
57+
**Improve Code**: To innovate and improve the code we use and provide.
7958

80-
1.2 [Branches](https://www.youtube.com/watch?v=oPpnCh7InLY)
59+
**Usability**: Increase the accessibility and uniformity of code throughout the organisation.
8160

82-
1.3 [Forks and Pull Requests](https://www.youtube.com/watch?v=_NrSWLQsDL4)
61+
**Cost Effective**: Reusable 'generalised' code will increase efficient in creating higher level processes.
8362

84-
1.4 [Issues](https://www.youtube.com/watch?v=WMykv2ZMyEQ)
63+
## Main Features
64+
?
8565

86-
Command Line
66+
## Instillation
67+
The package can be directly installed by typing in your terminal:
68+
```r
69+
python -m pip install --user git+https://github.com/codonlibrary/codonPython.git
70+
```
71+
For further guidance to clone a local repository to your machine from the remote repository using [GitBash/Command Line.](https://confluence.digital.nhs.uk/display/CON/Installing+codonPython?flashId=685465781)
72+
73+
## Contributing to codonPython
74+
All new contributions codon are welcome, please follow the Coding Conventions in the [guidance document.](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
75+
Any improvements to documentaion, bug fixes or general code enhancments are also welcomed. If a bug is found on the master branch please use the GitHub guidance on raising and [issue.](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue)
76+
77+
## New to GitHub?
78+
GitHub is a hosting site that allows for development and version control of software using Git. It allows users to edit and develop parts of code independently before submitting back to the master code, whilst using version control to track changes. Begginers introductionary videos to GitHub can be found [here.](https://confluence.digital.nhs.uk/display/CON/GitHub+for+beginners) Quick links to begginer guidance can be found below;
8779

88-
1.5 [Intro to Command Line](https://www.youtube.com/watch?v=oK8EvVeVltE)
80+
* [**Cloning a repositor to our local machine using GitBash**](https://confluence.digital.nhs.uk/display/CON/Installing+codonPython)
81+
* [**Checking out a branch using GitBash**](https://confluence.digital.nhs.uk/display/CON/Checkout+a+Branch+Using+GitBash)
82+
* [**Removing a Commit from a repository using GitBash**](https://confluence.digital.nhs.uk/display/CON/Information+Governance)
8983

90-
1.6 [Cloning Repo and Push/Pull](https://www.youtube.com/watch?v=yXT1ElMEkW8)
84+
All other `Codon` "How-to Articles" can be found [here](https://confluence.digital.nhs.uk/display/CON/How-to+articles)
9185

92-
1.7 [Git Init and Git Add](https://www.youtube.com/watch?v=9p2d-CuVlgc)
86+

0 commit comments

Comments
 (0)