Skip to content

Commit 741f4a2

Browse files
author
Tim Weber
committed
Added a preliminary README.
1 parent fbf8af3 commit 741f4a2

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
README for forscript
2+
3+
This project has just been open-sourced, this file is only preliminary.
4+
5+
6+
WHAT IS IT?
7+
===========
8+
9+
Please read <http://scytale.name/proj/forscript/>.
10+
11+
12+
WHAT'S THE STATUS?
13+
==================
14+
15+
It works and does what it's supposed to, although it could log more metadata.
16+
I'm currently working on transforming forscript from a thesis into an ordinary
17+
free software project, for example by providing a readme file and adding an
18+
open-source license (most likely GPLv3) to it.
19+
20+
21+
WHAT ARE ITS REQUIREMENTS?
22+
==========================
23+
24+
To generate the source file or the documentation, you need noweb:
25+
http://www.cs.tufts.edu/~nr/noweb/
26+
Generating the documentation additionally needs LaTeX and some packages.
27+
28+
To use the (pretty simple) Makefile, you need make. Duh.
29+
30+
To compile the source, a POSIX system with decent C99 compiler and library is
31+
required. Your also need to have the POSIX real-time extensions (clock_gettime)
32+
available. The most popular Unix which doesn't have these is Apple Mac OS X.
33+
Someone could patch forscript to use gettimeofday() there... (hint, hint!)
34+
35+
36+
HOW DO I BUILD IT?
37+
==================
38+
39+
Type "make". This should do the trick on most compatible systems. If your
40+
system is not compatible, hack forscript to support it and send me a patch! :)
41+
42+
43+
HOW CAN I CONTACT YOU?
44+
======================
45+
46+
<http://scytale.name/contact/> or <http://github.com/scy/>.

0 commit comments

Comments
 (0)