diff src/ploki/README @ 4223:ac0403686959

<oerjan> rm -rf src/ploki; mv ploki src
author HackBot
date Fri, 20 Dec 2013 22:18:50 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/ploki/README	Fri Dec 20 22:18:50 2013 +0000
@@ -0,0 +1,32 @@
+DESCRIPTION
+
+This is the ploki package. ploki is a programming language defined
+by its implementation and designed by accident. There are short example
+scripts in the examples/ subdirectory. You might want to copy
+syntax/ploki.vim and indent/ploki.vim into your ~/.vim/ directory if you're
+using vim; to get automatic filetype detection, create filetype.vim as
+described in :help new-filetype and add the following entry:
+    au BufNewFile,BufRead *.pk          setf ploki
+
+See the files in doc/ for a description of the language.
+
+BUILDING
+
+You need a C compiler. Compile all *.c files into a single executable called
+'ploki'. That's it.
+
+If you have make, typing 'make ploki' should invoke your C compiler with the
+right arguments. You may need to adjust some configuration variables: CC is
+the C compiler used; CFLAGS are default arguments for the compiler; LDFLAGS
+are default arguments for the linker.
+
+You should edit MakeSkel if you're using GNU make, Makefile otherwise. Note
+that Makefile is autogenerated by GNU make from MakeSkel and *.depend.
+
+There is no 'configure' script; ploki is almost completely standard C and
+should Just Work(TM). But have a look at config.h if you want to tweak the
+autodetection of gcc, C99, presence of /dev/urandom, etc.
+
+
+Have fun!
+Lukas Mai