Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: install: Reorder Install from source, py3.5 #703

Merged
merged 2 commits into from
Dec 24, 2021
Merged

docs: install: Reorder Install from source, py3.5 #703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cea01d
docs: install: Reorder Install from source, py3.5
ix5 Dec 24, 2021
e21a394
README: Link to install-from-source, LICENSE
ix5 Dec 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Isso – a commenting server similar to Disqus
============================================
# Isso – a commenting server similar to Disqus

Isso – *Ich schrei sonst* – is a lightweight commenting server written in
Python and JavaScript. It aims to be a drop-in replacement for
Expand All @@ -8,3 +7,10 @@ Python and JavaScript. It aims to be a drop-in replacement for
![Isso in Action](http://posativ.org/~tmp/isso-sample.png)

See [posativ.org/isso](http://posativ.org/isso/) for more details.

## License
MIT, see [LICENSE](LICENSE).

## Development
Refer to the docs for
[Installing from Source](https://posativ.org/isso/docs/install/#install-from-source).
29 changes: 18 additions & 11 deletions docs/docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Install from PyPi
Requirements
^^^^^^^^^^^^

- Python 2.7 or 3.4+ (+ devel headers)
- Python 3.5+ (+ devel headers)
- SQLite 3.3.8 or later
- a working C compiler

Expand Down Expand Up @@ -168,9 +168,10 @@ way to set up Isso. It requires a lot more dependencies and effort:
- Virtualenv
- SQLite 3.3.8 or later
- a working C compiler
- Node.js, `NPM <https://npmjs.org/>`__ - *for frontend*
- `sassc <https://github.com/sass/sassc>`_ for compiling
`.scss <https://sass-lang.com/>`_ - *for docs*
- Node.js, `NPM <https://npmjs.org/>`__ - *required for frontend*
- `sphinx <http://www.sphinx-doc.org/>`_,
`sassc <https://github.com/sass/sassc>`_ (for compiling
`.scss <https://sass-lang.com/>`_ to css) - *optional - only for docs*

Get a fresh copy of Isso:

Expand All @@ -186,24 +187,30 @@ To create a virtual environment (recommended), run:
~> virtualenv .
~> source ./bin/activate

Install Isso and its dependencies:
Install JavaScript modules using ``npm``:

.. code-block:: sh

~> python setup.py develop # or `install`
~> isso run
~> make init

Install JavaScript modules:
Build JavaScript frontend code:

.. code-block:: sh

~> make init
~> make js

Build JavaScript frontend code:
Install Isso and its dependencies:

.. code-block:: sh

~> make js
~> python setup.py develop # or `pip install -e .`
~> isso run

Install `sphinx <http://www.sphinx-doc.org/>`_ for generating docs:

.. code-block:: sh

~> pip install sphinx

Generate docs:

Expand Down