diff options
author | daid <daid303@gmail.com> | 2012-04-06 18:20:22 +0400 |
---|---|---|
committer | daid <daid303@gmail.com> | 2012-04-06 18:20:22 +0400 |
commit | 0626dae61cf7d5bd2b25ad367e3fde96e1c35fb7 (patch) | |
tree | cc1c66f98db146edec3cc7af0fced8e94721402a /README.md | |
parent | 1ded2a5c18d017b4ba80b5b87f3e63b12ae9a524 (diff) |
Update README to point people better to the right location
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000000..4bae532aec --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +Cura +==== + +If you are reading this, then you are looking at the *development* version of Cura. If you just want to use Cura look at the following location: https://github.com/daid/Cura/wiki + +Development +=========== + +Cura is developed in Python. Getting Cura up and running for development is not very difficult. If you copy the python and pypy from a release into your Cura development checkout then you can use Cura right away, just like you would with a release. +For development with git, check the help on github. Pull requests is the fastest way to get changes into Cura. + +Packaging +--------- + +Cura development comes with a script "package.sh", this script has been designed to run under unix like OSes (Linux, MacOS). Running it from sygwin is not a priority. +The "package.sh" script generates a final release package. You should not need it during development, unless you are changing the release process. If you want to distribute your own version of Cura, then the package.sh script will allow you to do that. + |