From eac5e81c073049f4d1b900877513d91e216dbf91 Mon Sep 17 00:00:00 2001 From: rachmadaniHaryono Date: Tue, 1 May 2018 18:08:50 +0800 Subject: [PATCH] chg: doc: bukuserver readme to rst --- bukuserver/README.md | 34 ------------------------------ bukuserver/README.rst | 49 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 34 deletions(-) delete mode 100644 bukuserver/README.md create mode 100644 bukuserver/README.rst diff --git a/bukuserver/README.md b/bukuserver/README.md deleted file mode 100644 index d31db65..0000000 --- a/bukuserver/README.md +++ /dev/null @@ -1,34 +0,0 @@ -#### Install server - -You need to have some packages before you install `bukuserver` on your server. So be sure to have `python3`, `python3-pip` , `python3-dev`, `libffi-dev` packages from your distribution. - -##### Installing PIP, virtualenv and dependencies - -``` -$ python3 -m pip install --user --upgrade pip -$ python3 -m pip install --user virtualenv -$ python3 -m virtualenv env -$ source env/bin/activate -$ git clone https://github.com/jarun/Buku -$ cd Buku -$ pip3 install .[server] -``` - -#### Installing buku and bukuserver from PIP - -``` -$ pip3 install buku[server] -``` - -#### Webserver options - -To run the server on host 127.0.0.1, port 5001, run following command: - - $ bukuserver run --host 127.0.0.1 --port 5001 -Visit `127.0.0.1:5001` in your browser to access your bookmarks. - -See more option on `bukuserver run --help` and `bukuserver --help` - -#### CAUTION - -This snapshot of web APIs is indicative. The program APIs are bound to change and if you need these, you may have to adapt the APIs to the current signature/return type etc. We are NOT actively updating these whenever an API changes in the main program. diff --git a/bukuserver/README.rst b/bukuserver/README.rst new file mode 100644 index 0000000..2e83fd5 --- /dev/null +++ b/bukuserver/README.rst @@ -0,0 +1,49 @@ +Bukuserver +========== + +Install server +-------------- + +You need to have some packages before you install `bukuserver` on your server. +So be sure to have `python3`, `python3-pip` , `python3-dev`, `libffi-dev` packages from your distribution. + +Installing PIP, virtualenv and dependencies +------------------------------------------- + +.. code:: shell + + $ python3 -m pip install --user --upgrade pip + $ python3 -m pip install --user virtualenv + $ python3 -m virtualenv env + $ source env/bin/activate + $ git clone https://github.com/jarun/Buku + $ cd Buku + $ pip3 install .[server] + +Installing buku and bukuserver from PIP +--------------------------------------- + +.. code:: shell + + $ pip3 install buku[server] + +Webserver options +----------------- + +To run the server on host 127.0.0.1, port 5001, run following command: + +.. code:: shell + + $ bukuserver run --host 127.0.0.1 --port 5001 + +Visit `127.0.0.1:5001` in your browser to access your bookmarks. + +See more option on `bukuserver run --help` and `bukuserver --help` + +CAUTION +------- + +This snapshot of web APIs is indicative. +The program APIs are bound to change and if you need these, +you may have to adapt the APIs to the current signature/return type etc. +We are NOT actively updating these whenever an API changes in the main program.