diff --git a/README.md b/README.md new file mode 100644 index 0000000..062e292 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +The Worst Programmer Ever +========================= + +A satirical blog about programming and general technology. + +## Installing + +```shell +git clone git://github.com/brettlangdon/theworstprogrammerever +cd ./theworstprogrammerever +npm install +``` + +## Running + +### Building + +If you would like to generate the blog you can run: + +```shell +make build +``` +Which will generate the static files necessary for the blog in `./build` + + +### Preview + +If you would like to preview the blog or any changes that you have made you can +run: + +```shell +make preview +``` + +Then visit http://localhost:8080/ + +## Contributing + +If you would like to contribute an article to http://theworstprogrammerever.com: + +1. Fork this repository +2. Add your article to `contents/articles//index.md` + 1. Format for `index.md` should be: + ```markdown + --- + title: + author: + date: YYY-MM-DD + template: article.jade + --- + + Short summary here + + --- + + This is the actual article. You can use whatever markdown you want. + ``` +3. If this is your first article please add yourself to +`contents/authors/.json` + 1. Format for `.json` should be: + ```json + { + "name": "", + "website": "" + } + ``` +4. Create a pull request to this repo to await review/merge +5. Profit + +The default [wintersmith](https://github.com/jnordberg/wintersmith) template diff --git a/readme.md b/readme.md deleted file mode 100644 index 6cb2899..0000000 --- a/readme.md +++ /dev/null @@ -1,4 +0,0 @@ - -# Blog - -The default [wintersmith](https://github.com/jnordberg/wintersmith) template