Readme update.

Browse Source
This commit is contained in:
retoor 2025-01-27 18:29:53 +01:00
parent 17820885d6
commit 2c448a951c
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -28,15 +28,26 @@ Markdown files have priority since they can use a html page with the same name a
It will resolve root (/) into resolving index.md or index.html. If both exist, index.md will be used. This rule applies for every directory. If you want a file list of a directory, use inline Python and pathlib for that. It will resolve root (/) into resolving index.md or index.html. If both exist, index.md will be used. This rule applies for every directory. If you want a file list of a directory, use inline Python and pathlib for that.
## Installation ## Get started
These are instructions for USING Dreamii, not to modify it.
```bash ```bash
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
pip install git+https://github.com/retoor/dreamii.git pip install git+https://molodetz.nl/retoor/dreamii.git
echo > "# My first dreamii site" > index.md echo > "# My first dreamii site" > index.md
dreamii serve 7331 dreamii serve 7331
``` ```
## Develop with Dreamii
Just clone the repository and run install.
```bash
git clone https://molodetz.nl/retoor/dreamii.git
# Create virtual environment and install dependencies.
make install
# Run appliction within environment.
make run
```
## Technologies used for creating this project ## Technologies used for creating this project
* Python3 as programming language. * Python3 as programming language.
* aiohttp for server. * aiohttp for server.