diff --git a/README.md b/README.md index 3648fea..46f683d 100644 --- a/README.md +++ b/README.md @@ -1,248 +1,47 @@ # Open Story Teller (OST) -Open Story Teller is an Open Source project to provide guidelines and software to build your own story teller box. +Open Story Teller is an Open Source project to provide guidelines and software to build your own story teller box (electronics, mechanical). -The main goal is to *not* make electronics boards but instead buy or reuse existing ones. This will allow you to easily repair your device with spare parts and avoid +The main goal is to *not* make electronics boards but instead buy or reuse existing ones. This will allow you to easily repair your device with spare parts. We propose a set of parts and firmware that is working well togather but your are free to custom everything to fit your needs. -*DO NOT CREATE YOUR OWN BOARD, JUST USE EXISTING ONES!* - This project can be used as a base platform for any device that is composed by: - A display (TFT...) - An Audio output - A SD card or memory - Some Buttons / rotary encoder / potentiometer -# Firmware/software +# Links -The firmware is highly configurable and highly portable. To achieve that, it is split in multiple parts: -- The core source file, which is common to every target -- the ports, dedicated to an embedded MCU and board -- The tests, to easily test part of source on a standard PC -- A desktop/mobile implementation +- http://openstoryteller.org/: main documentation and project news +- http://github.com/arabine/open-story-teller: source code, tickets, help -The core is written in pure C, targets implementations may add other languages and libraries (QML/C++/python ...). +# Generic player software -## GCC build system +The base software is highly portable and includes a micro virtual machine. This allow potential complex stories with loops, branches, user choices, randomization... -The project uses CMake as build system. For the embedded targets, the main CMakeLists.txt includes a generic cross compiler file that should be good for many configurations as soon as your compiler is GCC. +This project propose an minimal cross-platform GUI player application that can be used as a base project. -## Invocation +# StoryTeller Editor -1. Create a build directory (mkdir build) -2. Invoke cmake with some options, passed as definitions for CMake (-D