From bff2d7a412ffa81bdd13d07d095623256d19637c Mon Sep 17 00:00:00 2001 From: Andros Fenollosa Date: Fri, 1 Mar 2024 09:49:25 +0100 Subject: [PATCH] Add README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..38bf930 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Website and documentation + +This repository contains the source code for the website and documentation of Django Liveview. + +It is a static website generated with [one.el](https://one.tonyaldon.com/). + +## Do you want to contribute? + +Edit `one.el`. It is a org file that contains the documentation and text of the website. + +## Do you want to build the website? + +Install Emacs in your system. + +After that, you must install the `one.el` package. + +```bash +M-x package-install RET one.el RET +``` + +Then, open `one.el` and run the following command: + +```bash +M-x one-build +``` + +The website will be generated in the `public` directory.