Permalink
Browse files

Renames, docs, nginx.conf

  • Loading branch information...
1 parent 2fd2d21 commit b65417b70c11b840f7e2bea52202b9d11a2a1516 @alexkay committed Dec 15, 2011
Showing with 44 additions and 53 deletions.
  1. 0 AUTHORS → AUTHORS.md
  2. +0 −15 INSTALL
  3. +0 −7 README
  4. +28 −0 README.md
  5. +16 −0 nginx.conf
  6. +0 −18 src/app.yaml
  7. +0 −11 src/index.yaml
  8. +0 −2 {src → }/templates/api.txt
  9. 0 {src → }/templates/index.html
File renamed without changes.
View
@@ -1,15 +0,0 @@
-Installing hilite.me
-====================
-
-If you want to install hilite.me as your own App Engine application you need to do the following:
-
-* Download the latest [Pygments tarball][1] and copy the contents of the `pygments` directory into `./src/pygments`.
-* Open `./update` and set `--email` to your email address.
-* Open `./src/app.yaml` and change the application from `hilite-me` to your own.
-* Open `./src/templates/index.html` and remove the Google Analytics tracking code at the bottom of the template, or replace with our own.
-
-After this you can deploy the app using `./update`
-
-Please note that under AGPLv3 license deploying hilite.me requires that you share its source code with all modifications you have made. See COPYING for details.
-
-[1]: http://pygments.org/download/
View
@@ -1,7 +0,0 @@
-hilite.me is a small webapp that converts your code snippets into pretty-printed HTML format, easily embeddable into blog posts and websites.
-
-hilite.me is licensed under GNU Affero General Public License v3, see COPYING for details.
-
-hilite.me runs on Google App Engine and uses the Pygments project, see INSTALL for details.
-
-Please contact Alexander Kojevnikov <alexander@kojevnikov.com> with questions, comments and bug reports.
View
@@ -0,0 +1,28 @@
+# hilite.me
+
+[hilite.me](http://hilite.me/) is a small webapp that converts your code
+snippets into pretty-printed HTML format, easily embeddable into blog posts and
+websites.
+
+## Development
+
+To set up development environment you need to install these dependencies:
+
+* On FreeBSD: `portmaster textproc/py-pygments www/nginx www/py-flask`
+* On Debian: `aptitude install nginx python-flask python-pygments`
+
+Edit your main `nginx.conf`:
+
+ http {
+ ...
+ include /path/to/hilite.me/nginx.conf;
+ }
+
+Update the project location in `hilite.me/nginx.conf` and restart nginx.
+
+Add this line to your `/etc/hosts`:
+
+ 127.0.0.1 hilite.dev
+
+Type `make run` and go to <http://hilite.dev/>. If static files don't load make
+sure nginx has rx permissions for the `hilite.me/static` directory.
View
@@ -0,0 +1,16 @@
+server {
+ root /home/alex/Projects/hilite.me/static;
+ server_name hilite.dev;
+
+ proxy_set_header Host $host;
+
+ location / {
+ if (-f $request_filename) {
+ access_log off;
+ }
+
+ if (!-f $request_filename) {
+ proxy_pass http://127.0.0.1:5000;
+ }
+ }
+}
View
@@ -1,18 +0,0 @@
-application: hilite-me
-version: 2
-runtime: python
-api_version: 1
-
-handlers:
-- url: /favicon.ico
- static_files: static/favicon.ico
- upload: static/favicon.ico
- mime_type: vnd.microsoft.icon
-
-- url: /robots.txt
- static_files: static/robots.txt
- upload: static/robots.txt
- mime_type: text/plain
-
-- url: /.*
- script: main.py
View
@@ -1,11 +0,0 @@
-indexes:
-
-# AUTOGENERATED
-
-# This index.yaml is automatically updated whenever the dev_appserver
-# detects that a new type of query is run. If you want to manage the
-# index.yaml file manually, remove the above marker line (the line
-# saying "# AUTOGENERATED"). If you want to manage some indexes
-# manually, move them above the marker line. The index.yaml file is
-# automatically uploaded to the admin console when you next deploy
-# your application using appcfg.py.
@@ -9,5 +9,3 @@ GET or POST to http://www.hilite.me/api with these parameters:
* divstyles: CSS style to use in the wrapping <div> element, can be empty
The request will return the HTML code in UTF-8 encoding.
-
-Feel free to use the API as you see fit, but please let me know if you expect to have a lot of requests, I will need to bump the App Engine quotas.
File renamed without changes.

0 comments on commit b65417b

Please sign in to comment.