varia/distribusi
14
0
Fork 4
Code Issues 5 Pull Requests Releases Activity

Simplify install guide, add PyPi badge and access note

Browse Source
This commit is contained in:
Luke Murphy 2019-07-08 20:02:48 +02:00
parent df71f44550
commit e1ef66e646
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,5 +1,7 @@
# Distribusi CMS # Distribusi CMS
[![PyPI version](https://badge.fury.io/py/distribusi.svg)](https://badge.fury.io/py/distribusi)
`distribusi` is a content management system for the web that produces static `distribusi` is a content management system for the web that produces static
index pages based on folders in the filesystem. It is inspired by the automatic index pages based on folders in the filesystem. It is inspired by the automatic
index functions featured in several web servers. It works by traversing the index functions featured in several web servers. It works by traversing the
@ -18,26 +20,11 @@ packages:
## Installation ## Installation
Using [--user] or [a virtual environment] is recommended:
[--user]: https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site
[a virtual environment]: https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments
```bash ```bash
$ export PATH=$PATH:$HOME/.local/bin
$ pip install --user distribusi $ pip install --user distribusi
``` ```
Note: check if the path of your local bin is added to your shell path (otherwise you cannot run distribusi from the shell directly).
To check where distribusi is installed:
$ find * | grep distribusi
Add local bin to the $PATH variable:
$ PATH=$PATH:/home/USERNAME/.local/bin/
## Usage ## Usage
Get help with: Get help with:
@ -94,6 +81,9 @@ You're then ready to make your changes and experiment with them.
You'll need a [PyPi](https://pypi.org/) account and to be added as a maintainer. 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.
``` ```
$ pip install twine
$ make publish $ make publish
``` ```