Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #70 from doomhz/master

Added some docs about the author profile and running the project locally
  • Loading branch information...
commit 10eef1c144ba0d3c92495fb690ddd4a3bd332aff 2 parents cc25d32 + 90fb471
@creationix authored
Showing with 22 additions and 2 deletions.
  1. +22 −2 README.markdown
View
24 README.markdown
@@ -30,15 +30,35 @@ Every article is a markdown file with some meta-data at the top of the file.
I had so much fun writing the last article on control flow, that I decided to...
## First section: Display JavaScript files
-
+
* display contents of external JavaScript file (path is relative to .markdown file)
<test-code/test-file.js>
- * display contents of external JavaScript file and evaluate its contents
+ * display contents of external JavaScript file and evaluate its contents
<test-code/evaluate-file.js*>
More content goes here.
+### Author format
+
+Every author has a markdown file located in `authors` folder. You should name this file by your name and surname `Name Surname.markdown`.
+
+ Github: your_github_account
+ Email: your_email@domain.com
+ Homepage: http://yourhomepage.com
+ Twitter: your_twitter_account
+ Location: City, State, Country
+
+ A few words about you.
+
+### Starting the project on your local machine
+
+Please check if the project is still working after you add your contribution to it. You can run the project in three easy steps:
+
+1. Install the `npm`packages: `npm install`
+2. Start the server: `node server/server.js`
+3. Enjoy your local blog clone at `http://localhost:8080`
+
More docs to come soon...
## Licensing
Please sign in to comment.
Something went wrong with that request. Please try again.