Skip to content

Commit 8f134eb

Browse files
authored
Update README.md
1 parent 997ce51 commit 8f134eb

1 file changed

Lines changed: 2 additions & 42 deletions

File tree

README.md

Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,12 @@
55

66
`codonPython` will reduce the entry barrier for analysis and provide software development experience for those at a higher level of technical ability.
77

8-
## Why `codonPython`?
9-
10-
Transparency
11-
* To aline with government data principles and build public trust.
12-
13-
Improve Code
14-
* To innovate and improve the code we use and provide.
15-
16-
Usability
17-
* Increase the accessibility and uniformity of code throughout the organisation.
18-
19-
Cost Effective
20-
* Reusable 'generalised' code will increase efficient in creating higher level processes.
21-
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-
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-
# codonPython
44-
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)
47-
48-
`codonPython` will reduce the entry barrier for analysis and provide software development experience for those at a higher level of technical ability.
49-
508
## What is `codon`?
519

5210
`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)
5311

5412
#### Why `codon`?
13+
5514
**Transparency**: To aline with government data principles and build public trust.
5615

5716
**Improve Code**: To innovate and improve the code we use and provide.
@@ -61,6 +20,7 @@ Once the repository has been cloned to your local machine complete the following
6120
**Cost Effective**: Reusable 'generalised' code will increase efficient in creating higher level processes.
6221

6322
## Main Features
23+
6424
?
6525

6626
## Instillation

0 commit comments

Comments
 (0)