From 4654ced5e8dfe803b62bc6163fa3d88a73a9010a Mon Sep 17 00:00:00 2001 From: crunk Date: Fri, 22 Nov 2024 16:54:35 +0100 Subject: [PATCH] change README --- README.md | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 243efdc..46e9ea8 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,15 @@ index functions featured in several web servers. It works by traversing the file system and directory hierarchy to automatically list all the files in the directory and providing them with html classes and tags for easy styling. +## This distribusi fork powers distribusi-verse + +If you want to run distribusi on its own go here: [original](https://git.vvvvvvaria.org/varia/distribusi) +This version is used to power [distribusi-verse](https://git.vvvvvvaria.org/Toolsheds/distribusi-verse) which folds this tool in a webapplication. +To make this work a little easier this version has certain options removed that are handy +and available in the standalone version. + +For other distribusi like softwares also checkout [distribusi-go](https://git.coopcloud.tech/decentral1se/distribusi-go) + ## Requirements While a Pip install will pull in Python dependencies, you might need system @@ -85,29 +94,3 @@ The contribution consisted of setting up distribusi.ruruhuis.nl (distribusi is b > "Individuals collecting fragments each have their own folder. When they put a story, picture, audio, or video file inside a folder, each fragment is assigned a serial number, and gets accumulated in the fragments of hospitality website.The fragments connect us. We hope that we can choose the “nature and attitude” of the medium that mediates our connection." [https://fragments1444.ink/about.html](source) - -## Change It - -You'll need to get a copy of the repository and then do an [editable] install: - -[editable]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode - -```bash -$ git clone https://git.vvvvvvaria.org/varia/distribusi.git && cd distribusi -$ python3 -m venv .venv && source .venv/bin/activate -$ pip install -e . -``` - -You're then ready to make your changes and experiment with them. - -## Release It - -You'll need a [PyPi](https://pypi.org/) account and to be added as a maintainer. - -Please ask around @ Varia for who has PyPi access. - -``` -$ # ... change the version number in setup.py ... # -$ pip install twine wheel -$ make publish -```