Commit 528512a7 authored by Bhushan Shah's avatar Bhushan Shah 📱

Update README, convert other info files to Markdown

- Update `README` file with current info about KTurtle and screenshots
- Convert that and the rest of info documents to markdown for a more readable rendering on web view and for consistency

See merge request kde/kturtle!1
parents 4f10f85e deca6d53
Pipeline #360 passed with stage
in 4 minutes and 12 seconds
This diff is collapsed.
= 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.
= 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.
......@@ -19,15 +18,13 @@ Specific features of KTurtle:
* 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.
......
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=<PATH>' to configure the package for your
system.
Make sure to replace <PATH> 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.
<img src="https://invent.kde.org/kde/kturtle/raw/master/src/turtle.svg" align="right"
title="Kturtle logo" width="64" height="64">
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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment