diff --git a/README.md b/README.md index 8b137891791fe96927ad78e64b0aad7bded08bdc..927408c5c85c64ab8fa4c1be4bcaf1d4b46e46c1 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ +# Cambridge D10 Profile + +## Status + +This repository is under continued development and build currently. + +The contents of this repository have not been yet released for a formal v1.0 and we may introduce breaking changes into the repository and its content without warning at any point. This is to be used at your own risk. + +If you have any questions regarding this, please contact webmaster@admin.cam.ac.uk. + +## Local development with Gitflow + +Local development of this repository uses gitflow. + +Setup and usage can be found here: https://danielkummer.github.io/git-flow-cheatsheet/ + +Note, all defaults should be used during setup, so that (for example), `git flow feature start AM-123` results in a local branch named `git flow feature start feature/AM-123` diff --git a/README.txt b/README.txt deleted file mode 100644 index 70d53f972b0290141616fb45ef777923b9d60ec9..0000000000000000000000000000000000000000 --- a/README.txt +++ /dev/null @@ -1,5 +0,0 @@ -This repository is under continued development and build currently. - -The contents of this repository have not been yet released for a formal v1.0 and we may introduce breaking changes into the repository and its content without warning at any point. This is to be used at your own risk. - -If you have any questions regarding this, please contact webmaster@admin.cam.ac.uk. \ No newline at end of file