~brettgilio/orcircd-web

00652cc38fed3972cc088bc30c22eae6a0222943 — Brett Gilio 6 months ago 88e89c5
Add instructions section in README

* docs/README.org: Add instructions section, listing dependencies and
actions.
* README.org: --
2 files changed, 39 insertions(+), 0 deletions(-)

M README.md
M docs/README.org
M README.md => README.md +20 -0
@@ 5,6 5,26 @@
A modern, high-performance IRC server (ircd) [website]


## Instructions

Please install the latest version of [Soupault](https://soupault.neocities.org/) from `opam` by pinning the
development repository. Please ensure you make the following dependencies
installed on your system, and then run the following commands in the
directory:

-   `opam`
-   `python3` *(for running the webserver)*
-   `lua`

To generate the pages.

`$ make all`

To serve the website locally.

`$ make serve`


## License

This website is made available under the terms of the `CC0 1.0 Universal`

M docs/README.org => docs/README.org +19 -0
@@ 7,6 7,25 @@
A modern, high-performance IRC server (ircd) [website]


** Instructions
Please install the latest version of [[https://soupault.neocities.org/][Soupault]] from =opam= by pinning the
development repository. Please ensure you make the following dependencies
installed on your system, and then run the following commands in the
directory:

- =opam=
- =python3= /(for running the webserver)/
- =lua=

To generate the pages.

=$ make all=

To serve the website locally.

=$ make serve=


** License
This website is made available under the terms of the =CC0 1.0 Universal=
license. See [[./LICENSE][LICENSE]] for more details.