Add README

This commit is contained in:
Andros Fenollosa 2024-03-01 09:49:25 +01:00
parent 2337fc3f49
commit bff2d7a412

27
README.md Normal file
View File

@ -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.