search

kevinlawler / kona

Open-source implementation of the K programming language
ISC License
1.36k stars 138 forks source link

Better designed Kona GitHub README.md #159

Closed kevinlawler closed 10 years ago

kevinlawler commented 12 years ago

The README looks ugly. Update the README to be on par with the best GitHub projects. Images are recommended. Eventually a task for someone with solid design skills, anything would be an improvement over the current version.

kevinlawler commented 11 years ago

The README should be redesigned to convey the virtues of K. Installation instructions should be secondary. The discussion should be very high-level.

Anyone can try their hand at this.

thyrgle commented 10 years ago

I don't believe I can contribute because I keep getting permission denied, but how about something like this for now:

Kona

kona

What is Kona?

Kona is the open-source implementation of the K programming language. If you don't know APL, then this is the place to start. K is an ASCII-based APL. KDB (or Q) is the popular database software built on top of K. K was originally designed by Arthur Whitney and Kx Systems. Kona is unaffiliated with Kx.

Installation

Navigate to the file you want to install Kona, then type:

git clone https://github.com/kevinlawler/kona.git
cd kona
make                                #gamke on BSD

Then once in the file run:

./k                      #./k_test for debug mode

Further Information

You can find further information about Kona at the wiki.

kevinlawler commented 10 years ago

@thyrgle

Big improvement. I've added you as a collaborator, so now you should be able to commit your revision. Feel free to iterate if you like.

kevinlawler commented 10 years ago

Next step is #207. Source file list hides the improved design.