Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
shirok committed Oct 31, 2023
1 parent 6bb0648 commit 01c9895
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 4 deletions.
4 changes: 0 additions & 4 deletions README

This file was deleted.

44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# WiLiKi

This is WiLiKi, a Wiki engine written in [Gauche Scheme](https://practical-scheme.net/gauche).

You can visit the [official site](https://practical-scheme.net/wiliki/wiliki.cgi) for the details.

## Prerequisites

You need Gauche installed on your machine.
See (`package.scm`)[package.scm] for the required minimum version.

WiLiKi is supposed to run as a CGI script, so you need a web server
setup that can run CGI scripts.

Alternatively, you can install (Gauche-makiki)[https://github.com/shirok/Gauche-makiki] webserver to run WiLiKi stand-alone.


## Installation

Clone the repo, and run configure & make.

```
./configure
make
make -s check
make install
```

`make install` installs WiLiKi as a Gauche library.

## Running

To run the wiki, you need to copy (`wiliki.cgi`)[src/wiliki.cgi]
to your site's cgi script location and edit it to suit your
site's setup.

To run the wiki in stand-alone mode,
run `src/wiliki-server` script (you still need to prepare cgi
script with your own customization.)


```
wiliki-server -p <port> <your-customized-wiliki.cgi>
```

0 comments on commit 01c9895

Please sign in to comment.