Permalink
Browse files

update readme

  • Loading branch information...
deluxghost committed Jul 6, 2018
1 parent d616ddb commit 42f9147423c38ab1b64ea141454ab87a54b11296
Showing with 7 additions and 63 deletions.
  1. +1 −57 DelogX/DESCRIPTION.rst
  2. +6 −6 README.md
View
@@ -1,57 +1 @@
DelogX is a lite, tiny, micro and dynamic Markdown based blogging platform, written in Python and powered by Flask.
Features
--------
- Small, little, lite, tiny and micro.
- Easy to install and deploy.
- Write and publish with Markdown.
- Manage articles in one directory.
- No database and admin panel, everything is file.
- Compatible with Windows, macOS, Linux and even WSL or Android.
- Everything is configurable.
- Customize your blog with plugins and themes.
- Deploy on Apache, Nginx, standalone WSGI containers or just built-in server.
Installation
------------
Install DelogX with pip:
.. code:: shell
pip3 install DelogX
You may need root permissions:
.. code:: shell
sudo pip3 install DelogX
Getting Started
---------------
After installing, Create a new directory to store your blog application, and enter it.
.. code:: shell
mkdir my_blog
cd my_blog
Then run command:
.. code:: shell
delogx init
and follow the instructions to initialize.
When the process is complete, run:
.. code:: shell
python3 debug.py
and visit "http://127.0.0.1:8000" to test if everything is ok.
If everything is ok, you can read the `documentation <https://github.com/deluxghost/DelogX/wiki>`__ to learn about how to config and how to add posts.
Check the description on `Github <https://github.com/deluxghost/DelogX/>`__.
View
@@ -29,7 +29,7 @@ Install DelogX with pip:
pip3 install DelogX
```
You may need root permissions:
You may be required to have root permission:
```shell
sudo pip3 install DelogX
@@ -44,22 +44,22 @@ mkdir my_blog
cd my_blog
```
Then run command:
Then execute this command:
```shell
delogx init
```
and follow the instructions to initialize.
and follow the instructions finish the initialization.
When the process is complete, run:
After the process is complete, run this:
```shell
python3 debug.py
```
and visit "http://127.0.0.1:8000" to test if everything is ok.
and visit "http://127.0.0.1:8000" in your browser to test if everything is ok.
If everything is ok, you can read the [documentation] to learn about how to config and how to add posts.
If everything is ok, you can read the [documentation] to learn about how to configure and how to add posts.
[documentation]: https://github.com/deluxghost/DelogX/wiki

0 comments on commit 42f9147

Please sign in to comment.