diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 6b29f2e..0000000 --- a/INSTALL +++ /dev/null @@ -1,178 +0,0 @@ - - - -See README for specific instuction on how to build KTurtle! - - - - - -The following is default stuff: - -Basic Installation -================== - - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes a while. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Type `make install' to install the programs and any data files and - documentation. - - 4. You can remove the program binaries and object files from the - source code directory by typing `make clean'. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`configure' also accepts some other, not widely useful, options. - diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..126bce5 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,167 @@ +:zap: **These installation instructions are outdated and require a +refresh**. Nowadays kturtle uses `CMake` as its build system, whereas +the instructions on the doc refer to the old `autotools` build system. + +## Basic Installation + + These are generic installation instructions to install kturtle from +source. They are intended for developers only, as most users will want +to install it from the packages available for their OS. + + The `configure` shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile` in each directory of the package. +It may also create one or more `.h` files containing system-dependent +definitions. Finally, it creates a shell script `config.status` that +you can run in the future to recreate the current configuration, a file +`config.cache` that saves the results of its tests to speed up +reconfiguring, and a file `config.log` containing compiler output +(useful mainly for debugging `configure`). + + If you need to do unusual things to compile the package, please try +to figure out how `configure` could check whether to do them, and mail +diffs or instructions to the address given in the `README` so they can +be considered for the next release. If at some point `config.cache` +contains results you don`t want to keep, you may remove or edit it. + + The file `configure.in` is used to create `configure` by a program +called `autoconf`. You only need `configure.in` if you want to change +it or regenerate `configure` using a newer version of `autoconf`. + +The simplest way to compile this package is: + + 1. `cd` to the directory containing the package`s source code and type + `./configure` to configure the package for your system. If you`re + using `csh` on an old version of System V, you might need to type + `sh ./configure` instead to prevent `csh` from trying to execute + `configure` itself. + + Running `configure` takes a while. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make` to compile the package. + + 3. Type `make install` to install the programs and any data files and + documentation. + + 4. You can remove the program binaries and object files from the + source code directory by typing `make clean`. + +## Compilers and Options + + Some systems require unusual options for compilation or linking that +the `configure` script does not know about. You can give `configure` +initial values for variables by setting them in the environment. Using +a Bourne-compatible shell, you can do that on the command line like +this: + + CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure + +Or on systems that have the `env` program, you can do it like this: + env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure + +## Compiling For Multiple Architectures + + You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make` that +supports the `VPATH` variable, such as GNU `make`. `cd` to the +directory where you want the object files and executables to go and run +the `configure` script. `configure` automatically checks for the +source code in the directory that `configure` is in and in `..`. + + If you have to use a `make` that does not supports the `VPATH` +variable, you have to compile the package for one architecture at a time +in the source code directory. After you have installed the package for +one architecture, use `make distclean` before reconfiguring for another +architecture. + +## Installation Names + + By default, `make install` will install the package`s files in +`/usr/local/bin`, `/usr/local/man`, etc. You can specify an +installation prefix other than `/usr/local` by giving `configure` the +option `--prefix=PATH`. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +give `configure` the option `--exec-prefix=PATH`, the package will use +PATH as the prefix for installing programs and libraries. +Documentation and other data files will still use the regular prefix. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure` the +option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`. + +## Optional Features + + Some packages pay attention to `--enable-FEATURE` options to +`configure`, where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE` options, where PACKAGE +is something like `gnu-as` or `x` (for the X Window System). The +`README` should mention any `--enable-` and `--with-` options that the +package recognizes. + + For packages that use the X Window System, `configure` can usually +find the X include and library files automatically, but if it doesn`t, +you can use the `configure` options `--x-includes=DIR` and +`--x-libraries=DIR` to specify their locations. + +## Specifying the System Type + + There may be some features `configure` can not figure out +automatically, but needs to determine by the type of host the package +will run on. Usually `configure` can figure that out, but if it prints +a message saying it can not guess the host type, give it the +`--host=TYPE` option. TYPE can either be a short name for the system +type, such as `sun4`, or a canonical name with three fields: + + CPU-COMPANY-SYSTEM + +See the file `config.sub` for the possible values of each field. If +`config.sub` isn`t included in this package, then this package doesn`t +need to know the host type. + + If you are building compiler tools for cross-compiling, you can also +use the `--target=TYPE` option to select the type of system they will +produce code for and the `--build=TYPE` option to select the type of +system on which you are compiling the package. + +## Sharing Defaults + + If you want to set default values for `configure` scripts to share, +you can create a site shell script called `config.site` that gives +default values for variables like `CC`, `cache_file`, and `prefix`. +`configure` looks for `PREFIX/share/config.site` if it exists, then +`PREFIX/etc/config.site` if it exists. Or, you can set the +`CONFIG_SITE` environment variable to the location of the site script. +A warning: not all `configure` scripts look for a site script. + +## Operation Controls + + `configure` recognizes the following options to control how it +operates. + +`--cache-file=FILE` + Use and save the results of the tests in FILE instead of + `./config.cache`. Set FILE to `/dev/null` to disable caching, for + debugging `configure`. + +`--help` + Print a summary of the options to `configure`, and exit. + +`--quiet` +`--silent` +`-q` + Do not print messages saying which checks are being made. + +`--srcdir=DIR` + Look for the package`s source code in directory DIR. Usually + `configure` can determine that directory automatically. + +`--version` + Print the version of Autoconf used to generate the `configure` + script, and exit. + +`configure` also accepts some other, not widely useful, options. + diff --git a/MANIFESTO b/MANIFESTO deleted file mode 100644 index 481ee77..0000000 --- a/MANIFESTO +++ /dev/null @@ -1,41 +0,0 @@ - = KTURTLE MANIFESTO = - -KTurtle is an educational programming environment that aims to make programming as easy and touchable as possible. It is not intended to be a general purpose porgramming language, but merely helps a student who is new to programming to quickly get a basic understanding. - - - == Why not use an existing programming language to teach? == - -Many programming languages exist, yet usually require the programmer to have a basic understanding of English. Usually it is even more than a basic understanding that is needed, the terminology used in the error messages of a programming language can be quite difficult. - -Furthermore one finds that many programming languages come with a variety of separate tools and often require understaning of a command shell or IDE (integrated development environment) in order to used. This raises the entry barrier for someone new to programming as a lot has to be learned in order to see the first results. - -KTurtle is one integrated program, and is _fully_ transaltable into the native language of the student. KTurtle is not the first educational programming language, there are some implementations of the LOGO programming language with comparable features. Yet most of these products are not freely available, not available on the main platforms (Linux, Windows and OSX), miss translations, are not actively maintained. - -Specific features of KTurtle: - * highlighting during execution (shows what the executer is executing) - * highlighting of errors - * context help (hit F2 for help on the piece of script right under the cursor) - * fully translatable (the programming language itself, the examples, the error messages, the GUI, the manual... everything) - * yet still RealCoding(tm), no clicky clicky stuff - * and everything in one program (instead of separate: debugger, documentation, IDE, interpreter, etc.) - - - == Why do you not implement LOGO? == - -KTurtle started off with a syntax that was more close to LOGO. Many complaints arose claiming KTurtle was not LOGO enough (doing things different, missing features, or just not being 100% compliant). While there is no such thing as a LOGO standard, most refered to UCB-LOGO as the defacto standard. - -To solve this issue Cies Breijs, the initiator off the project, decided to move away from the LOGO'ish syntax to a syntax that is more similar to commonly used programming languages like C, C++, Java, PHP, Perl, Python, Ruby, C#, VB and ASP. This will make it a little easier for a student to move from KTurtle to general purpose programming languages. - - - == Where does the turtle come from? == - -Some versions of LOGO shipped with (something similar to) Turtle-Graphics. This is a set of commands to move a turtle around and use it to make drawings. The initiator of KTurtle, Cies Breijs, learned programming using MSX-LOGO which also featured a turtle. As a reference to the roots of KTurtle (LOGO and Turtle-Graphics) the turtle has been kept as a symbol of educational programming. - - - - - - - - - diff --git a/FAQ b/MANIFESTO.md similarity index 92% rename from FAQ rename to MANIFESTO.md index f9e4e4c..a4d2ced 100644 --- a/FAQ +++ b/MANIFESTO.md @@ -1,41 +1,38 @@ - = KTURTLE MANIFESTO = +# KTURTLE MANIFESTO -KTurtle is an educational programming environment that aims to make programming as easy and touchable as possible. It is not intended to be a general purpose porgramming language, but merely helps a student who is new to programming to quickly get a basic understanding. +KTurtle is an educational programming environment that aims to make programming as easy and touchable as possible. It is not intended to be a general purpose programming language, but merely helps a student who is new to programming to quickly get a basic understanding. - - == Why not use an existing programming language to teach? == +## Why not use an existing programming language to teach? Many programming languages exist, yet usually require the programmer to have a basic understanding of English. Usually it is even more than a basic understanding that is needed, the terminology used in the error messages of a programming language can be quite difficult. Furthermore one finds that many programming languages come with a variety of separate tools and often require understaning of a command shell or IDE (integrated development environment) in order to used. This raises the entry barrier for someone new to programming as a lot has to be learned in order to see the first results. KTurtle is one integrated program, and is _fully_ transaltable into the native language of the student. KTurtle is not the first educational programming language, there are some implementations of the LOGO programming language with comparable features. Yet most of these products are not freely available, not available on the main platforms (Linux, Windows and OSX), miss translations, are not actively maintained. Specific features of KTurtle: * highlighting during execution (shows what the executer is executing) * highlighting of errors * context help (hit F2 for help on the piece of script right under the cursor) * fully translatable (the programming language itself, the examples, the error messages, the GUI, the manual... everything) * yet still RealCoding(tm), no clicky clicky stuff * and everything in one program (instead of separate: debugger, documentation, IDE, interpreter, etc.) - - == Why not implement LOGO? == +## Why do you not implement LOGO? KTurtle started off with a syntax that was more close to LOGO. Many complaints arose claiming KTurtle was not LOGO enough (doing things different, missing features, or just not being 100% compliant). While there is no such thing as a LOGO standard, most refered to UCB-LOGO as the defacto standard. To solve this issue Cies Breijs, the initiator off the project, decided to move away from the LOGO'ish syntax to a syntax that is more similar to commonly used programming languages like C, C++, Java, PHP, Perl, Python, Ruby, C#, VB and ASP. This will make it a little easier for a student to move from KTurtle to general purpose programming languages. - - == Where does the turtle come from? == +## Where does the turtle come from? Some versions of LOGO shipped with (something similar to) Turtle-Graphics. This is a set of commands to move a turtle around and use it to make drawings. The initiator of KTurtle, Cies Breijs, learned programming using MSX-LOGO which also featured a turtle. As a reference to the roots of KTurtle (LOGO and Turtle-Graphics) the turtle has been kept as a symbol of educational programming. diff --git a/README b/README deleted file mode 100644 index b11066b..0000000 --- a/README +++ /dev/null @@ -1,95 +0,0 @@ -Hi, - -you are reading the README of the 'KTurtle' project that is initiated -and maintained by Cies Breijs (cies-AT-showroommama-DOT-nl). In this -README I will tell you how to get KTurtle running on your computer. - - - -1. Requirements -You need to have KDE 3.2 or higher. I don't know if it will work with different -KDE versions since I did not test it. If it does not work please see -the Questions section below. - - - -2. Compiling -The simplest way to compile this package is: - - 1) `cd' to the directory containing the package's source code and type - `./configure --prefix=' to configure the package for your - system. - - Make sure to replace by the path wher your KDE apps are - installed. This is mostly '/usr', but sometimes (for SuSE) '/opt/kde'. - If you dont know what to do try: `./configure --prefix=/usr'. If you don't give a --prefix the default path /usr/local will be used, resulting that KTurtle will no be with your other apps, and may not run smoothly. - - Running `configure' takes a while. While running, it prints some - messages telling which features it is checking for. If the - configure script exits with an error it will probably hint you - what it needs in order to succeed. - - 2) Type `make' to compile the package. - - 'make' also takes a while, and it also has the possibility to exit - with errors. Although the errors messages 'make' produces are mostly - not as clear as the error messages from 'configure', they are a hint - to what went wrong. Please see the Questions section below if you - dont know what to do with these messages. - -If it succeeded a binary named 'kturtle' is made and can be find in the -'src' directory within the directory containing the package's source -code. - -Before you can run KTurtle you need to install it. - - - -3. Installing -NOTE: you often need 'root' privilliges to do the following! - - 1) Type `make install' to install the programs and any data files and - documentation. - - 2) You can remove the program binaries and object files from the - source code directory by typing `make clean'. - -If you want to uninstall KTurtle you should type 'make uninstall' when -in the source code directory. - -Please note that 'make install' will install KTurtle to the path that is provided to the './configure' command with the '--prefix' flag! - - -4. Running -Under normal circumstances should be able to run KTurtle from the -commandline by typing 'kturtle'. - -If it does not work please go to the source code directory of KTurtle -and type: - - cd src - ./kturlte - -If this does not work please follow instuction form the Question section. - - - -5. Questions -Check out the FAQ in the source code directory of KTurtle to see if your -question has allready been asked. - -You can also mail questions to the mail address you find in the -beginning of this document. Or visit the KTurtle website: -http://kturlte.sf.net , or http://edu.kde.org/kturtle -and post it in the forum. - - - -Thanks for reading! - -Cies. - - - - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..39652c0 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ + + +KTurtle is an educational programming environment that uses TurtleSpeak, a programming language loosely based on and inspired by [LOGO](http://en.wikipedia.org/wiki/Logo_programming_language). + +The goal of KTurtle is to make programming as easy and accessible as possible. This makes KTurtle suitable for teaching young students the basics of math, geometry and... programming. + +## Features + +Some of the main features of KTurtle include: +* the ability to translate the programming commands into the native language of the student using the KDE translation framework. +* all you need integrated in in one application. +* simplified programming terminology. +* intuitive syntax highlighting and error markers. + +![Kturtle](icons/kturtle.gif) + +Learn more in the [KTurtle manifesto](MANIFESTO.md). \ No newline at end of file diff --git a/TODO b/TODO.md similarity index 100% rename from TODO rename to TODO.md diff --git a/icons/kturtle.gif b/icons/kturtle.gif new file mode 100644 index 0000000..23ba28b Binary files /dev/null and b/icons/kturtle.gif differ diff --git a/scripts/README b/scripts/README.md similarity index 100% rename from scripts/README rename to scripts/README.md