summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3bb151
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+OpenSkyPlanetarium plugin for Stellarium
+=====================================
+
+Plugin for controlling the Arduino-Based Laser and Stellarium to create Planetarium shows.
+
+
+BUILDING THE PLUGIN
+===================
+
+Please note, these instructions are only directly applicable to Linux.
+Windows and OSX targets will probably require modification of the
+CMakeLists.txt file.
+
+0. Install and build the SVN version of Stellarium as per the
+instructions on the Stellarium wiki:
+
+ http://stellarium.org/wiki/index.php/Compilation_on_Linux
+
+1. Set the environment variable STELROOT to the root of the Stellarium
+source tree. The Stellarium build directory is expected to be:
+
+ $STELROOT/builds/unix
+
+2. Create a sub-directory builds/unix in your plugin folder and change into that directory.
+
+3. Run:
+
+ cmake ../..
+ make
+ make install
+
+If all goes well, the relevant files should be built and copied to your
+~/.stellarium/modules directory.
+
+