chiark / gitweb /
Update README to point people better to the right location
authordaid <daid303@gmail.com>
Fri, 6 Apr 2012 14:20:22 +0000 (16:20 +0200)
committerdaid <daid303@gmail.com>
Fri, 6 Apr 2012 14:20:22 +0000 (16:20 +0200)
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index 7d879ae..0000000
--- a/README
+++ /dev/null
@@ -1,66 +0,0 @@
-For documentation check: https://github.com/daid/Cura/wiki
-For downloads check: https://github.com/daid/Cura/downloads
-
-This package includes two programs:
-
-Pronterface:
-
-    An application for both manually controlling and automatically feeding gcode to a 3D printer.
-
-Cura:
-
-   A easy to use program for slicing STL files using SkeinForge. Cura can also visualize the 3D models in a variety of ways.
-
-   On first run, Cura will ask to go through a set of calibration steps that will perform a series of operations on your 3D printer. One of those steps involves extruding a bit of filament where the filament is initially nearly fully extracted.  As such, it you will probably need to run Pronterface first, heat up the extruder enough to be able to extract the filament and then use the Pronterface interface to reverse the extruder motor until the filament is at the right position (specifically, until the filament end is even with where the Bowden tube leaves the extuder motor assembly, on an Ultimaker).
-
-========
-BUILDING
-========
-
-    ./package.sh
-    
-The build script defaults to building for Windows.  If you want to build for Mac OS X or Linux, choose one of:
-
-    ./package.sh osx64
-    ./package.sh linux
-
-Note that Mac OS X currently requires the manual installation of wxPython, PySerial, and PyOpenGL:
-
-    sudo easy_install-2.7 pyserial
-    sudo easy_install-2.7 PyOpenGL
-
-You will need to download the appropriate wxPython Installer package and install it.  It is available from:
-
-    http://www.wxpython.org/download.php
-
-Specifically, install "wxPython2.9-osx-cocoa-py2.7" as it is the build that supports 64-bit execution.
-
-=======
-RUNNING
-=======
-
-Windows
--------
-
-Double-click skeinforge.bat and Printrun.bat.
-
-Mac OS X & Linux
-----------------
-
-Once built, the two apps -- Pronterface and Cura -- must be started from the command line (for now):
-
-    # open a new terminal window and....
-    cd osx64-Cura-NewUI-Beta4
-    ./pronterface.sh &
-    ./Cura.sh &
-
-This will start both applications with their console logging output directed into the terminal window.
-
-========
-FIRMWARE
-========
-
-For Ultimaker users, it is highly recommended -- nearly required -- that you upgrade your firmware to the latest Marlin builds.  See:
-
-    http://wiki.ultimaker.com/Skeinforge_PyPy
-
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..4bae532
--- /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.
+