Permalink
Browse files

README formatting

  • Loading branch information...
rwdaigle committed Jan 16, 2012
1 parent 9b6414c commit 6bc98bcb1143d3cc87289d31d16663b8996f3607
Showing with 6 additions and 12 deletions.
  1. +6 −12 README → README.md
View
@@ -1,23 +1,18 @@
-This is a prototype of treating an article like an application. Namely, the ability to locally edit
-article contents contained within a README using the editor of the author's choice and to render
-the article locally using (remote, and thus up-todate) Dev Center styling. This does not attempt to
-address deployment to the Dev Center.
+This is a prototype of treating an article like an application. Namely, the ability to locally edit article contents contained within a README using the editor of the author's choice and to render
+the article locally using (remote, and thus up-todate) Dev Center styling. This does not attempt to address deployment to the Dev Center.
-This is also a start in the direction of providing a git repo complete with article template for
-authors to fork and begin editing with minimal overhead.
+This is also a start in the direction of providing a git repo complete with article template for authors to fork and begin editing with minimal overhead.
## Clone Template Article
-Begin by forking [this template repo](https://github.com/rwdaigle/devcenter-article) to your own your own GitHub account.
-Then clone to copy the template to the local environment.
+Begin by forking [this template repo](https://github.com/rwdaigle/devcenter-article) to your own your own GitHub account. Then clone to copy the template to the local environment.
$ git clone git@github.com:YOURUSER/devcenter-article.git my-article
$ cd my-article
## Render Article Locally
-Before editing the article run the article to see its rendered state in a local environment
-that provides real-time rendering of the article contents.
+Before editing the article run the article to see its rendered state in a local environment that provides real-time rendering of the article contents.
$ foreman start
15:30:24 web.1 | started with pid 42618
@@ -26,8 +21,7 @@ Open your browser to [localhost:5000](http://localhost:5000) to view the article
## Edit Article
-Edit the article in the `README` file. Save changes and go back to the browser. Reloading [localhost:5000](http://localhost:5000)
-will re-render the article without a server restart.
+Edit the article in the `README` file. Save changes and go back to the browser. Reloading [localhost:5000](http://localhost:5000) will re-render the article without a server restart.
## Submit

0 comments on commit 6bc98bc

Please sign in to comment.