Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

more for the README

  • Loading branch information...
commit 9d1bef1eb6a3176e38eefbfd01f333c5bd96df66 1 parent a343e62
Joshua Tauberer authored January 27, 2012

Showing 1 changed file with 18 additions and 11 deletions. Show diff stats Hide diff stats

  1. 29  README
29  README
@@ -5,7 +5,9 @@ This is a Django site to publish a book online, converting LaTeX into HTML.
5 5
 
6 6
 Dependencies
7 7
 ------------
8  
-	poppler-utils
  8
+	Django 1.3 or later
  9
+	python-plastex (to read LaTeX files)
  10
+	poppler-utils (to convert .pdf figures to images)
9 11
 
10 12
 Configuration
11 13
 -------------
@@ -20,8 +22,7 @@ Put your LaTeX source files in:
20 22
 
21 23
 Create the following files in this directory:
22 24
 	
23  
-settings_local.py
24  
------------------
  25
+settings_local.py:
25 26
 SECRET_KEY = "something long and random, see Django for details"
26 27
 DEFAULT_BOOK = "mybook"	 				# root directory of book content
27 28
 HASHTAG = "myhashtag"					# suggested hashtag, no #-sign
@@ -36,8 +37,7 @@ numbers, e.g.:
36 37
 	
37 38
 	EMBARGO_CHAPTERS = { "mybook": (2, 3, 4) }
38 39
 
39  
-metadata.html
40  
--------------
  40
+metadata.html:
41 41
 <!-- HTML Metadata -->
42 42
 <title>Your Book Title</title>
43 43
 <meta name="description" content="Your Book Description">
@@ -55,19 +55,26 @@ metadata.html
55 55
 <meta itemprop="name" content="Your Book Name">
56 56
 <meta itemprop="description" content="Your Book Description">
57 57
 
58  
-header.html
59  
------------
  58
+header.html:
60 59
 <h1>My Book</h1>
61 60
 <h2>Subtitle subtitle subtitle subtitle</h2>
62 61
 <h2>By Your Name</h2>
63 62
 
64  
-footer.html
65  
------------
  63
+footer.html:
66 64
 <div class="copyright">Copyright &copy; 2012 Your Name</div>
67 65
 
68  
-home.html
69  
----------
  66
+home.html:
70 67
 <div style="padding: 2em 3em 2em 2em">
71 68
 	<p>This book is the culmination of much work.</p>
72 69
 </div>
73 70
 
  71
+Running The Site
  72
+----------------
  73
+
  74
+Check that the site works locally with:
  75
+	
  76
+	python manage.py runserver
  77
+	
  78
+The first time a page is hit, the LaTeX source file will be processed. For large
  79
+documents, this can take a little while.
  80
+

0 notes on commit 9d1bef1

Please sign in to comment.
Something went wrong with that request. Please try again.