Merge branch 'restification'

Conflicts:
	.gitignore
	CONTRIBUTING.rst
This commit is contained in:
James Kasten 2015-03-21 14:03:36 -07:00
commit ce2a6b7c5a
3 changed files with 10 additions and 29 deletions

1
.gitignore vendored
View file

@ -8,3 +8,4 @@ venv/
m3
*~
.vagrant
*.swp

View file

@ -4,14 +4,16 @@ Hacking
=======
In order to start hacking, you will first have to create a development
environment:
environment. Start by `installing dependencies and setting up Let's Encrypt`_.
Now you can install the development packages:
::
./venv/bin/python setup.py dev
The code base, including your pull requests, **must** have 100% test statement
coverage **and** be compliant with the :ref:`coding-style`.
coverage **and** be compliant with the coding-style_.
The following tools are there to help you:
@ -23,34 +25,9 @@ The following tools are there to help you:
- ``./venv/bin/tox -e lint`` checks the style of the whole project,
while ``./venv/bin/pylint --rcfile=.pylintrc file`` will check a single `file` only.
.. _installing dependencies and setting up Let's Encrypt: https://letsencrypt.readthedocs.org/en/latest/using.html
.. _coding-style:
Vagrant
=======
If you are a Vagrant user, Let's Encrypt comes with a Vagrantfile that automates
setting up a development environment in an Ubuntu 14.04 LTS VM. To set it up,
simply run ``vagrant up``. The repository is synced to ``/vagrant``, so you can
get started with:
::
vagrant ssh
cd /vagrant
./venv/bin/python setup.py install
sudo ./venv/bin/letsencrypt
Support for other Linux distributions coming soon.
**Note:** Unfortunately, Python distutils and, by extension, setup.py and tox,
use hard linking quite extensively. Hard linking is not supported by the
default sync filesystem in Vagrant. As a result, all actions with these
commands are *significantly slower* in Vagrant. One potential fix is to `use
NFS`_ (`related issue`_).
.. _use NFS: http://docs.vagrantup.com/v2/synced-folders/nfs.html
.. _related issue: https://github.com/ClusterHQ/flocker/issues/516
Coding style
============

View file

@ -57,6 +57,7 @@ Current Features
* web servers supported:
- apache2.x (tested and working on Ubuntu Linux)
- standalone (runs its own webserver to prove you control the domain)
* the private key is generated locally on your system
* can talk to the Let's Encrypt (demo) CA or optionally to other ACME
@ -79,6 +80,8 @@ Documentation: https://letsencrypt.readthedocs.org/
Software project: https://github.com/letsencrypt/lets-encrypt-preview
Notes for developers: [CONTRIBUTING.rst](/CONTRIBUTING.rst)
Main Website: https://letsencrypt.org/
IRC Channel: #letsencrypt on `Freenode`_