Skip to content

Commit

Permalink
Reorganize sections in README
Browse files Browse the repository at this point in the history
  • Loading branch information
hongquan committed May 26, 2020
1 parent c5e897f commit b1c7f1f
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ For other Python dependencies, this project is using `Poetry`_ to manage. Please
to install those dependencies.


Run from source
---------------

.. code-block:: sh
python3 -m cobang
Add ``-v`` option to see more detailed log.


Package for Debian/Ubuntu
-------------------------

Expand Down Expand Up @@ -155,25 +166,12 @@ Follow this step to package:
debuild -S
Run
+++

Because the software is not packaged, you have to run it from development source folder:

.. code-block:: sh
python3 -m cobang
Add ``-v`` option to see more detailed log.


Credit
++++++

- Brought to you by `Nguyễn Hồng Quân <author_>`_.

- Icons from `www.flaticon.com`_, made by `Freepik`_, `Good Ware <good_ware_>`_.
- Some contributors who proposed nicer UI for this app.

.. [1] Every Electron application brings along a pair of NodeJS + Chromium, which make the package size > 50MB, no matter how small the application code is. To make the situation worse, those NodeJS + Chromium set are not shared. It means that if you installed two Electron apps, you end up having two set of NodeJS & Chromium in your system!
.. [2] Ubuntu PPA requires to upload source package, not prebuilt binary. Read more at: https://help.launchpad.net/Packaging/PPA/Uploading
Expand Down

0 comments on commit b1c7f1f

Please sign in to comment.