Added readme and license.

This commit is contained in:
Ian Adam Naval 2014-01-28 01:53:59 -05:00
parent 46db2ec2d6
commit 413e655f7a
2 changed files with 52 additions and 0 deletions

20
LICENSE Normal file
View File

@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2014 Ian Adam Naval
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

32
README.md Normal file
View File

@ -0,0 +1,32 @@
ianonavy
========
Source code for my personal website.
Requirements
------------
* python 2.6+
* pip
* virtualenv
* nginx
* supervisord
Installing
----------
Exact commands vary with OS.
1. Clone git repository.
2. Create a virtual environment in the same directory, and source the `activate` script.
3. Navigate into the directory and install the required Python packages with `pip install -r requirements.txt`.
4. Symlink or copy the file `conf/nginx.conf` into the nginx configuration directory (e.g. `/etc/nginx/conf.d/ianonavy.conf` for CentOS).
5. Symlink or copy the file `conf/supervisord.conf` into the supervisord configuration directory.
6. Reload the config files of both nginx and supervisord, and ensure that both daemons are running.
Note that you probably need to edit the config files to point to the directory in which you cloned this repo as well as the `server_name` for nginx.
Updating
--------
To update, just run `git pull` in the repository. For the Web service, you may need to instruct supervisord to restart the daemons.