Minor edits to README.md
This commit is contained in:
parent
97d1fcc7f3
commit
52a9a7b358
1 changed files with 8 additions and 8 deletions
16
README.md
16
README.md
|
@ -1,31 +1,31 @@
|
|||
# yannesposito.com
|
||||
|
||||
This is the source code of yannesposito.com website.
|
||||
This is the source code of the [yannesposito.com](yannesposito.com) website.
|
||||
|
||||
It is mainly a multi-language blog based on [nanoc](nanoc.stoneship.org).
|
||||
|
||||
_Notice, this is not a clean system.
|
||||
Mainly because I use it for some years now.
|
||||
Mainly because I have used it for some years now.
|
||||
I just want it to work, not to be a nice piece of code.
|
||||
But in the end I know I will make it clean._
|
||||
|
||||
What you'll need to use it:
|
||||
|
||||
- [nanoc](nanoc.stoneship.org) → `gem install nanoc`
|
||||
- [zsh](zsh.org) → By default installed on most good system
|
||||
- [zsh](zsh.org) → Installed by default on most good system
|
||||
- A bunch of gems: `gem install ultraviolet krambook sass rainpress`
|
||||
|
||||
Optionally
|
||||
|
||||
- [graphviz](graphviz.org)
|
||||
|
||||
Here is a short explanation of each file role:
|
||||
Here is a short explanation of the role of each file:
|
||||
|
||||
|
||||
config.rb → nanoc central configuration file
|
||||
config.ru → Rack server configuration
|
||||
config.yaml → A YAML configuration file (mostly strings)
|
||||
content/ → The directory where nanoc will search most content
|
||||
content/ → The directory where nanoc will search for most of the content
|
||||
img_latest_blog_dir@ → A link to the latest blog image directory
|
||||
latest.md@ → A link to the latest blog file
|
||||
layouts/ → HTML Layouts for your webpages
|
||||
|
@ -34,15 +34,15 @@ Here is a short explanation of each file role:
|
|||
output/ → Where the content is loaded
|
||||
Rakefile → Ruby actions
|
||||
README.md → This file
|
||||
resources/ → Some file I used and wanted to keep
|
||||
resources/ → Some files I used and wanted to keep
|
||||
Rules → Generation rules
|
||||
tasks/ → Where I putted most of my scripts
|
||||
tasks/ → Where I put most of my scripts
|
||||
|
||||
|
||||
Here are features I added:
|
||||
|
||||
analytics.rb → Functions to add web analytics code
|
||||
calendar.rb → Function show a date nicely in HTML
|
||||
calendar.rb → Functions to show a date nicely in HTML
|
||||
gitmtime.rb → Show time using git last change log
|
||||
graph.rb → Use graphviz to draw graphs
|
||||
helpers.rb → Some standard nanoc helpers are added
|
||||
|
|
Loading…
Reference in a new issue