Browse Source

Update README and LICENSE files to reflect additions

Update LICENSE file to include licences for Open Sans and Source Code Pro.
Update README to include additional settings options.
master
Andrew Senetar 6 years ago
parent
commit
c6dbafd192
2 changed files with 163 additions and 13 deletions
  1. 121
    2
      LICENSE.md
  2. 42
    11
      README.md

+ 121
- 2
LICENSE.md View File

@@ -34,7 +34,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 34
 Component Licenses 
35 35
 -------------------
36 36
 
37
-### Foundation 4
37
+### [Foundation 4]( http://foundation.zurb.com )
38 38
 ~~~
39 39
 Copyright (c) 2011 ZURB, http://www.zurb.com/
40 40
 
@@ -59,7 +59,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
59 59
 
60 60
 ~~~
61 61
 
62
-### Zeptos.js
62
+### [Zeptos.js]( http://zeptojs.com/ )
63 63
 ~~~
64 64
 Copyright (c) 2010-2012 Thomas Fuchs
65 65
 http://zeptojs.com/
@@ -143,3 +143,122 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
143 143
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
144 144
 
145 145
 ~~~
146
+
147
+### [Open Sans]( http://opensans.com/ )
148
+
149
+~~~
150
+Copyright  Steve Matteson
151
+
152
+Licensed under the Apache License, Version 2.0 (the "License");
153
+you may not use this file except in compliance with the License.
154
+You may obtain a copy of the License at
155
+
156
+	http://www.apache.org/licenses/LICENSE-2.0
157
+
158
+Unless required by applicable law or agreed to in writing, software
159
+distributed under the License is distributed on an "AS IS" BASIS,
160
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
161
+See the License for the specific language governing permissions and
162
+limitations under the License.
163
+
164
+~~~
165
+
166
+### [Source Code Pro]( https://github.com/adobe/source-code-pro )
167
+
168
+~~~
169
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
170
+
171
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
172
+
173
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
174
+
175
+
176
+-----------------------------------------------------------
177
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
178
+-----------------------------------------------------------
179
+
180
+PREAMBLE
181
+The goals of the Open Font License (OFL) are to stimulate worldwide
182
+development of collaborative font projects, to support the font creation
183
+efforts of academic and linguistic communities, and to provide a free and
184
+open framework in which fonts may be shared and improved in partnership
185
+with others.
186
+
187
+The OFL allows the licensed fonts to be used, studied, modified and
188
+redistributed freely as long as they are not sold by themselves. The
189
+fonts, including any derivative works, can be bundled, embedded, 
190
+redistributed and/or sold with any software provided that any reserved
191
+names are not used by derivative works. The fonts and derivatives,
192
+however, cannot be released under any other type of license. The
193
+requirement for fonts to remain under this license does not apply
194
+to any document created using the fonts or their derivatives.
195
+
196
+DEFINITIONS
197
+"Font Software" refers to the set of files released by the Copyright
198
+Holder(s) under this license and clearly marked as such. This may
199
+include source files, build scripts and documentation.
200
+
201
+"Reserved Font Name" refers to any names specified as such after the
202
+copyright statement(s).
203
+
204
+"Original Version" refers to the collection of Font Software components as
205
+distributed by the Copyright Holder(s).
206
+
207
+"Modified Version" refers to any derivative made by adding to, deleting,
208
+or substituting -- in part or in whole -- any of the components of the
209
+Original Version, by changing formats or by porting the Font Software to a
210
+new environment.
211
+
212
+"Author" refers to any designer, engineer, programmer, technical
213
+writer or other person who contributed to the Font Software.
214
+
215
+PERMISSION & CONDITIONS
216
+Permission is hereby granted, free of charge, to any person obtaining
217
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
218
+redistribute, and sell modified and unmodified copies of the Font
219
+Software, subject to the following conditions:
220
+
221
+1) Neither the Font Software nor any of its individual components,
222
+in Original or Modified Versions, may be sold by itself.
223
+
224
+2) Original or Modified Versions of the Font Software may be bundled,
225
+redistributed and/or sold with any software, provided that each copy
226
+contains the above copyright notice and this license. These can be
227
+included either as stand-alone text files, human-readable headers or
228
+in the appropriate machine-readable metadata fields within text or
229
+binary files as long as those fields can be easily viewed by the user.
230
+
231
+3) No Modified Version of the Font Software may use the Reserved Font
232
+Name(s) unless explicit written permission is granted by the corresponding
233
+Copyright Holder. This restriction only applies to the primary font name as
234
+presented to the users.
235
+
236
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
237
+Software shall not be used to promote, endorse or advertise any
238
+Modified Version, except to acknowledge the contribution(s) of the
239
+Copyright Holder(s) and the Author(s) or with their explicit written
240
+permission.
241
+
242
+5) The Font Software, modified or unmodified, in part or in whole,
243
+must be distributed entirely under this license, and must not be
244
+distributed under any other license. The requirement for fonts to
245
+remain under this license does not apply to any document created
246
+using the Font Software.
247
+
248
+TERMINATION
249
+This license becomes null and void if any of the above conditions are
250
+not met.
251
+
252
+DISCLAIMER
253
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
254
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
255
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
256
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
257
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
258
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
259
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
260
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
261
+OTHER DEALINGS IN THE FONT SOFTWARE.
262
+
263
+~~~
264
+

+ 42
- 11
README.md View File

@@ -1,7 +1,7 @@
1 1
 Pelican-red
2 2
 ============
3 3
 
4
-**Alpha Quality Pre-v0.1.0**
4
+**Beta Quality Pre-v0.1.0**
5 5
 
6 6
 Pelican-red is a [pelican](http://getpelican.com) theme designed to be readable on every device. It is a responsive layout which utilizes the [Foundation 4](http://foundation.zurb.com/) framework. The theme was originally created for the blog [VoltaicIdeas](http://blog.voltaicideas.net) and has a few additional features in addition to the original design to make it more useful. Pelican-red is Licensed under the MIT-License.     
7 7
 
@@ -9,8 +9,8 @@ Features
9 9
 ---------
10 10
 The following is a list of features:
11 11
 
12
-* Responsive design view-able on mobile down to 380px wide **(check)**
13
-* Fixed top-bar w/drop-down navigation & social links
12
+* Responsive design view-able on mobile down to about 230px wide
13
+* Top-bar w/drop-down navigation & social links
14 14
     * Social links with Icons from [Entypo](http://www.entypo.com) by Daniel Bruce or [Zocial](http://zocial.smcllns.com/) by Sam Collins; currently supported ( icon font pack in parenthesis ):
15 15
         * Blogger ( Zocial )
16 16
         * Dribbble ( Entypo )
@@ -40,10 +40,14 @@ The following is a list of features:
40 40
 * Analytics via Google Analytics ( new version ) or GoSquared 
41 41
 * Disqus comments support **(TODO FINISH)** 
42 42
 * PDF link support
43
-* pygments code highlighting
43
+* pygments code highlighting with responsive layout
44 44
 * Site Icons for Creative Commons Licenses, VCards, Tags, PDF download, Search, and Translation selection using [Entypo](http://www.entypo.com) by Daniel Bruce
45 45
 * Google Custom Search Support
46
-* more ...
46
+* Open Sans used for style font
47
+* Source Code Pro used for code blocks
48
+* Supports the following pelican-plugins (plus others):
49
+  * multi_part
50
+  * neighbors
47 51
 
48 52
 Install
49 53
 --------
@@ -87,16 +91,23 @@ Variables are listed as `variable` : description
87 91
 * `SITE_DESCR`: Description of site used for meta if you want
88 92
 * `SITE_KEY`: Keywords for meta ex. `"keyword1, keyword2, keyword3"`
89 93
 * `FAVICON`: Path to favicon ex. `images/favicon`
90
-* `COPYRIGHTS`: Copyright dictionary `['Abbriviation': ('name','url')]`
91
-* `DEFAULT_COPYRIGHT` : Default copyright to use is an abbriviation key from the `COPYRIGHTS` dictionary 
92
-* `COPYRIGHT_ARTICLE` : Show default copyright on articles (overridable with article value)
93
-* `COPYRIGHT_PAGE` : Show default copyright on pages (overridable with page value)
94
+* `COPYRIGHTS`: Copyright dictionary `['Abbreviation': ('name','url')]`
95
+  * using `cc`, `cc-nc`, etc will generate iconified copyright links
96
+* `DEFAULT_COPYRIGHT` : Default copyright to use is an abbreviation key from the `COPYRIGHTS` dictionary 
97
+* `COPYRIGHT_ARTICLE` : Show default copyright on articles (over-ridable with article value)
98
+* `COPYRIGHT_PAGE` : Show default copyright on pages (over-ridable with page value)
94 99
 
95 100
 ### Navigation
96 101
 * `MENUITEMS`: Custom Links to place in the menu e. `(('Item', 'Link'))`
97 102
 * `DISPLAY_PAGES_ON_MENU`: Show pages on the menu; has three options `False` - do not display, `Compact` - display as dropdown with 'Pages' Heading, and `Expanded` - display each as a seperate top level item.
98 103
 * `DISPLAY_CATEGORIES_ON_MENU` : Show the categories on the menu; has same options `False` - do not display, `Compact` - display as dropdown with 'Categories' Heading, and `Expanded` - display each as a seperate top level item.
99 104
 
105
+### Sidebar
106
+* `INCLUDE_TAGS_LINK` : True / False Include link to tags page on sidebar.
107
+* `INCLUDE_CATS_LINK` : True / False Include link to categories page on sidebar.
108
+* `INCLUDE_ARCH_LINK` : True / False Include link to archives page on sidebar.
109
+* `INCLUDE_AUTH_LINK` : True / False Include link to authors page on sidebar.
110
+
100 111
 ### Social
101 112
 * `SOCIAL`: List of the social links and urls ex. `(('Network','url'),)`, supported w/icon listed below:
102 113
     * Blogger : `('blogger','http://myblog.blogspot.com')`
@@ -122,21 +133,41 @@ Variables are listed as `variable` : description
122 133
     * Vimeo : `('vimeo','http://vimeo.com/channels/channelID')`
123 134
     * YouTube : `('youtube','http://www.youtube.com/channel/channelID')`
124 135
 
136
+### Index Page
137
+* `ARTICLES_ON_INDEX` : number of recent articles to show
138
+* `PAGES_ON_INDEX` : True / False
139
+
125 140
 ### Comments ( Disqus )
126 141
 * `DISQUS_SN`: Disqus Shortname of site ( VoltaicIdeas )
127 142
 * `COMMENTS_PAGE`: Include Comments on pages set True/False
128 143
 * `COMMENTS_ARTICLE`: Include Comments on articles set True/False
129 144
 
145
+### Authors ( vcards )
146
+* `AUTHORS` : a dictionary of authors
147
+  * `vcard` : a tuple of tuples of author vcard values support includes (not limited though ):
148
+    * `fn` : Full Name
149
+    * `email` : [email protected]
150
+    * `photo` : url to an image about 150px
151
+    * `title` : Awesome Person, Blog Writer, etc
152
+    * `org` : some company
153
+    * `notes` : this can be a bio / anything really
154
+  * `social` : (('network','link'),) same as SITE_SOCIAL parameters
155
+
130 156
 ### Analytics ( Google Analytics and GoSquared )
131 157
 * `GOOGLE_ANALYTICS`: Google Analytics Code and Domain ex. `( UA-xxxxxxxx-x' , 'voltaicideas.net' )`
132 158
 * `GO_SQUARED`: GoSquared Code ex. `'GSN-xxxxxx-x'`
133 159
 
160
+### Google Custom Search
161
+* `GOOGLE_SEARCH`: set to the unique search id number "var cx = 'this value' "
162
+
134 163
 Per Article / Page Variables
135 164
 --------------------------
136 165
 In addition to the additional configuration variables the theme supports the following variables in articles / pages.
137 166
 
138
-* `comments`: show comments True/False
167
+* `comments`: show comments True/False overrides the site comments setting
139 168
 * `copyright`: copyright to display at bottom of page / article overrides the site `DEFAULT_COPYRIGHT` value
169
+* `modified` : a modified time
170
+* `image` : a cover image for the article also used as icon in listings path relative to `static` directory
140 171
 
141 172
 Previews
142 173
 ---------
@@ -157,4 +188,4 @@ TODO
157 188
 
158 189
 Change-log ( Major Details )
159 190
 -------------------------
160
-* `v0.1.0` First Release
191
+* `v0.1.0` First Release

Loading…
Cancel
Save