Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100755 88 lines (66 sloc) 4.447 kb
645eae1 @trishume some profiling and documentation/readme
trishume authored
1 #Open Turing 1.0
3d3ff5b @trishume Made Readme better
trishume authored
2 ####Current lead maintainer: Tristan Hume
3 #####Download: https://github.com/downloads/Open-Turing-Project/OpenTuring/package.zip
4
645eae1 @trishume some profiling and documentation/readme
trishume authored
5
96f17ab @trishume fixed examples directory
trishume authored
6
7
645eae1 @trishume some profiling and documentation/readme
trishume authored
8 Open Turing is an open-source implementation of Turing for Windows.
a19ed0c @trishume updated read me
trishume authored
9 I (Tristan Hume) acquired the source code from Tom West, the last maintainer of the project.
10 This version is backwards-compatible with normal turing.
645eae1 @trishume some profiling and documentation/readme
trishume authored
11
12 As well as being open-source it is also faster and has more features.
13 Unfortunately, at the moment many of these features are undocumented.
14 Look at the "How to Learn About New Features" section for more info.
15
16 ###Partial change log:
17 * Up to a 40% speed increase. (depends on program)
18 * Built in hash maps
19 * Basic OpenGL 3D. Beta, no input.
20 * Command line invocation with turing.exe -run file.t
21 * New splash and logo
22
3d3ff5b @trishume Made Readme better
trishume authored
23 ###To Get/Download It:
24 * Download the zip: https://github.com/downloads/Open-Turing-Project/OpenTuring/package.zip
25 * Or look in the downloads tab
645eae1 @trishume some profiling and documentation/readme
trishume authored
26 * If you want the development release, click the zip button, download it and look in the /turing/test folder.
27
28 ###How to Learn About New Features
29
30 Look in the support/predefs folder of the distribution. If you see an interesting looking module name, open the file in turing.
31
32 Read the functions in the module. I.E the Hashmap.tu module has the functions for using hashmaps. The GL.tu file has OpenGL functions.
33
96f17ab @trishume fixed examples directory
trishume authored
34 For usage examples (helpful!) look in the Examples/Open Turing folder. These may not exist for every feature.
645eae1 @trishume some profiling and documentation/readme
trishume authored
35
36 ###Support policy (Or lack thereof)
37 * If the editor crashes it will show an email. Send panic.log to the email and describe how the crash happened.
38 * You can also go to the "Issues" tab and post an issue.
39 * Otherwise, ask for help on http://compsci.ca/
40
41 ##For Programmers/Developers/Writers/People who want to help out.
42
43 ###How it works
44
45 The Turing environment is written in C with some parts as C compiled from Turing Plus.
46 Compiling is done through a MS Visual C++ 2010 project (works with express.)
47
48 It compiles turing code to bytecode which is executed with a VM.
49 If you don't know what that means, go add library functions but don't mess with the language itself.
50
51 The main file for the project is /turing/turing.sln this contains the various sub-projects.
52 The main executable is the "Turing" subproject. The standalone executable project is called "Prolog."
53 To get a fully working release with your changes you must compile both of these. For testing (if you don't need standalone executables) you only have to compile the "Turing" project.
54
55 ####Various other sub-projects:
56 * MIO - The main library. Includes things like Sprites, Drawing, Input, etc...
57 * Editor - The IDE. Located in the /ready folder but accessed from the main project.
58 * TLib - Standard library for compiled turing plus
59 * Coder/Compiler - Translates from turing code to bytecode.
60 * Executor - The bytecode VM.
61 * Interperer - The link between the compiler and executor.
62
63 ####Things you should care about:
64 * To add library functions:
65 1. Add a file to the MIO project. Remember to use MIO prefixes, look at one of the existing files (I.E miofont.c)
66 2. MIO prefix = platform independent (or mostly independent.) MDIO = Windows only.
67 3. Write wrappers for your functions in "miowrapper.c". Look at the other wrappers for examples.
68 4. Add your functions to lookup.c (I think it's in the Coder project.) Remember, the functions must be in alphabetical order.
69 5. Write a turing module file that uses "external" declarations to declare the functions using the identifiers you used in lookup.c
70 6. Put the file in the support/predefs folder and put the file name in support/predefs/predefs.lst
71 * The main projects you should care about are Editor, MIO, Executor, Compiler and Coder.
72 * The VS project builds to /turing/test
73 * I (Tristan) figured all this out with almost no instruction. So you should be OK.
74
75 ###How to Submit Contributions:
76 1. Get github! (Seriously, it's awesome.)
77 2. Fork the project
78 3. Commit changes to your fork.
79 4. Send a pull request with your changes.
80 5. If your changes are any good they will be included in the main distribution.
81
82 ###How Can I Help?
83 * If you understand how the code works write about it on the project wiki (It's a tab up top.) This helps other people get started quicker.
84 * Write documentation for new features
85 * Write examples for new features.
86 * Profile the bytecode VM and make it faster. This is hard because the VM is compiled to C from Turing Plus.
87 * Write new features!
Something went wrong with that request. Please try again.