Martin Zimmermann
10 years ago
commit
ce35b9ff0e
@ -1,22 +1,48 @@
|
||||
all: css js
|
||||
ISSO_JS_SRC := $(shell find isso/js/app -type f) $(shell ls isso/js/*.js | grep -vE "(min|dev)")
|
||||
ISSO_JS_DST := isso/js/embed.min.js isso/js/embed.dev.js isso/js/count.min.js isso/js/count.dev.js
|
||||
|
||||
ISSO_CSS_DST := isso/css/isso.css
|
||||
ISSO_CSS_SRC := isso/css/isso.scss
|
||||
ISSO_CSS_SRC_DEPS := $(shell find isso/css -type f | grep .scss)
|
||||
|
||||
RST := $(shell find docs/ -type f -name '*.rst')
|
||||
MAN := man/man1/isso.1 man/man5/isso.conf.5
|
||||
|
||||
WWW := docs/index.html docs/isso.example.cfg $(wildcard docs/_static/*)
|
||||
CSS := docs/_static/css/site.css
|
||||
|
||||
all: man js site
|
||||
|
||||
init:
|
||||
(cd isso/js; bower install almond requirejs requirejs-text)
|
||||
|
||||
css:
|
||||
scss isso/css/isso.scss isso/css/isso.css
|
||||
${ISSO_CSS_DST}: $(ISSO_CSS_SRC_DEPS)
|
||||
scss --no-cache $(ISSO_CSS_SRC) $@
|
||||
|
||||
isso/js/%.min.js: $(ISSO_JS_SRC) $(ISSO_CSS_DST)
|
||||
r.js -o isso/js/build.$*.js out=$@
|
||||
|
||||
js:
|
||||
r.js -o isso/js/build.embed.js
|
||||
r.js -o isso/js/build.embed.js optimize="none" out="isso/js/embed.dev.js"
|
||||
r.js -o isso/js/build.count.js
|
||||
r.js -o isso/js/build.count.js optimize="none" out="isso/js/count.dev.js"
|
||||
isso/js/%.dev.js: $(ISSO_JS_SRC) $(ISSO_CSS_DST)
|
||||
r.js -o isso/js/build.$*.js optimize="none" out=$@
|
||||
|
||||
site:
|
||||
cd docs/ && sphinx-build -E -b dirhtml -a . _build
|
||||
scss docs/_static/css/site.scss docs/_build/_static/css/site.css
|
||||
js: $(ISSO_JS_DST)
|
||||
css: $(ISSO_CSS_DST)
|
||||
|
||||
man: $(RST)
|
||||
sphinx-build -b man docs/ man/
|
||||
|
||||
${CSS}: docs/_static/css/site.scss
|
||||
scss --no-cache $< $@
|
||||
|
||||
site: $(RST) $(WWW) $(CSS)
|
||||
cd docs && sphinx-build -b dirhtml . _build/html
|
||||
|
||||
coverage:
|
||||
nosetests --with-doctest --with-doctest-ignore-unicode --with-coverage \
|
||||
--cover-package=isso --cover-html isso/ specs/
|
||||
|
||||
clean:
|
||||
rm -f $(MAN) $(CSS) $(ISSO_JS_DST) $(ISSO_CSS_DST)
|
||||
|
||||
.PHONY: clean site man init js css
|
||||
|
||||
|
||||
@ -1,59 +0,0 @@
|
||||
Development
|
||||
===========
|
||||
|
||||
If you want to hack on Isso or track down issues, there's an alternate
|
||||
way to set up Isso. It requires a lot more dependencies and effort.
|
||||
|
||||
Requirements:
|
||||
|
||||
- Python 2.6, 2.7 or 3.3
|
||||
- Ruby 1.8 or higher
|
||||
- Node.js, [NPM](https://npmjs.org/) and [Bower](http://bower.io/)
|
||||
|
||||
On Debian/Ubuntu install the following packages
|
||||
|
||||
~> sudo aptitude install python-setuptools python-dev npm ruby
|
||||
~> ln -s /usr/bin/nodejs /usr/bin/node
|
||||
|
||||
Get the repository:
|
||||
|
||||
~> git clone https://github.com/posativ/isso.git
|
||||
~> cd isso/
|
||||
|
||||
Install `virtualenv` and create a new environment for Isso (recommended):
|
||||
|
||||
~> pip install virtualenv
|
||||
~> virtualenv .
|
||||
~> source ./bin/activate
|
||||
|
||||
Install Isso dependencies:
|
||||
|
||||
~> python setup.py develop
|
||||
~> isso run
|
||||
|
||||
Compile SCSS to CSS:
|
||||
|
||||
~> gem install sass
|
||||
~> scss --watch isso/css/isso.scss
|
||||
|
||||
Install JS components:
|
||||
|
||||
~> make init
|
||||
~> # or cd isso/js && bower install almond requirejs requirejs-text
|
||||
|
||||
|
||||
Integration
|
||||
-----------
|
||||
|
||||
```html
|
||||
<script src="/isso/js/config.js"></script>
|
||||
<script data-main="/isso/js/embed" src="/isso/js/components/requirejs/require.js"></script>
|
||||
```
|
||||
|
||||
|
||||
Optimization
|
||||
------------
|
||||
|
||||
~> npm install -g requirejs uglifyjs
|
||||
~> make js
|
||||
~> # or r.js -o /isso/js/build.embed.js
|
||||
@ -0,0 +1,38 @@
|
||||
Isso
|
||||
====
|
||||
|
||||
What's Isso?
|
||||
------------
|
||||
|
||||
Isso is a lightweight commenting server similar to Disqus. It allows anonymous
|
||||
comments, maintains identity and is simple to administrate. It uses JavaScript
|
||||
and cross-origin ressource sharing for easy integration into static websites.
|
||||
|
||||
No, I meant "Isso"
|
||||
------------------
|
||||
|
||||
Isso is an informal, german abbreviation for "Ich schrei sonst!", which can
|
||||
roughly be translated to "I'm yelling otherwise". It usually ends the
|
||||
discussion without any further arguments.
|
||||
|
||||
In germany, Isso `is also pokémon N° 360`__.
|
||||
|
||||
.. __: http://bulbapedia.bulbagarden.net/wiki/Wynaut_(Pok%C3%A9mon)
|
||||
|
||||
What's wrong with Disqus?
|
||||
-------------------------
|
||||
|
||||
No anonymous comments (IP address, email and name recorded), hosted in the USA,
|
||||
third-party. Just like IntenseDebate, livefrye etc. When you embed Disqus, they
|
||||
can do anything with your readers (and probably mine Bitcoins, see the loading
|
||||
times).
|
||||
|
||||
Setup
|
||||
-----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../quickstart
|
||||
../troubleshooting
|
||||
|
||||
Loading…
Reference in new issue