Skip to content

Commit b6b9411

Browse files
authored
Update README.md
1 parent d40afb0 commit b6b9411

1 file changed

Lines changed: 32 additions & 2 deletions

File tree

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,39 @@
1-
# Example package
1+
# codonPython
22

33
[![Build Status](https://travis-ci.com/codonlibrary/codonPython.svg?branch=master)](https://travis-ci.com/codonlibrary/codonPython)
44
[![codecov](https://codecov.io/gh/codonlibrary/codonPython/branch/master/graph/badge.svg)](https://codecov.io/gh/codonlibrary/codonPython)
55

6-
This is a simple example of a future package pulled from the DPS Core code base.
6+
`codonPython` will reduce the entry barrier for analysis and provide software development experience for those at a higher level of technical ability.
7+
8+
## Why `codonPython`?
9+
10+
Transparency
11+
* Aline with government data principles and build public trust.
12+
Improve Code
13+
* Innovate and improve the code we provide.
14+
Usability
15+
* Increase the accessibility of code throughout the organisation.
16+
Cost Effective
17+
* Reusable generalised code will increase efficient in creating higher level processes.
18+
19+
## New to GitHub?
20+
21+
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 a 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.
22+
23+
[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;
24+
GitHub Basics
25+
26+
1.1 [Intro (hyper link all below)](https://www.youtube.com/watch?v=BCQHnlnPusY)
27+
1.2 Branches
28+
1.3 Forks and Pull Requests
29+
1.4 Issues
30+
Command Line
31+
1.5 Intro to Command Line
32+
1.6 Cloning Repo and Push/Pull
33+
1.7 Git Init and Git Add
34+
35+
36+
## Installation
737
The package can be directly installed by typing in your terminal: `python -m pip install --user git+https://github.com/codonlibrary/codonPython.git`
838

939
Include info on what each text file / folder is:

0 commit comments

Comments
 (0)