Skip to content

Commit

Permalink
Update documentation and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Vetter committed Mar 16, 2013
1 parent 78ae91d commit c1ae3b3
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*.swp
*.sw[po]
*.py[co]
.vagrant
MANIFEST
Expand Down
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
include README.rst
include LICENSE
include CHANGELOG.rst
19 changes: 18 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
virtual-node
============

Continuous integration status:

.. image:: https://secure.travis-ci.org/elbaschid/virtual-node.png
:target: http://travis-ci.org/#!/elbaschid/virtual-node


This package is a wrapper around the `node.js`_ sources and provides a
convenient way to install it directly into your ``virtualenv`` instead
of globally. I created this package to play around with a simple
Expand All @@ -25,17 +31,28 @@ I am using this in combination with `virtual-less`_ which installs the
Installation
------------

.. warning:: This will download the node.js sources and compile it into your
virtualenv. Make sure that you have all required build dependencies for
node.js installed before installing virtual-node. The installation will
take quite a long time to run for the first time around, so have a coffee
or a beer handy.

Installing the ``node`` into your virtual environment is as easy as::

$ pip install virtual-node

that should be it. You should now be able to run ``node`` from within
That should be it. You should now be able to run ``node`` from within
your virtual environment even if you have it globally installed. You
can make sure that this is the case::

$ which node
/home/elbaschid/.virtualenvs/lessc-test/bin/node

.. note:: virtual-node is explicitly meant to be installed into a virtualenv
and not into your global environment. This has not been tested and will
most likely not work or cause problems. Only try it if you know what you
are doing.

Issues & Contributions
----------------------

Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,8 @@ def install_node(self, env_dir, version=None):
author='Sebastian Vetter',
author_email='sebastian@roadside-developer.com',
url='http://github.com/elbaschid/virtual-node',
long_description=open('README.rst', 'r').read(),
long_description="%s\n\n%s" % (open('README.rst').read(),
open('CHANGELOG.rst').read()),
classifiers=[
'Development Status :: 3 - Alpha',
'Environment :: Console',
Expand Down

0 comments on commit c1ae3b3

Please sign in to comment.