@ -5,48 +5,31 @@ A satirical blog about programming and general technology.
## Installing
`theworstprogrammerever` requires `hugo` to build the server
```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:
# build the static files
hugo
```shell
make build
# run development server at http://localhost:1313
hugo server -w
```
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 /<article-title-here>/index.md`
2. Add your article to `content/post/<article-title-here>/index.md`
1. Format for `index.md` should be:
```markdown
---
title: < article-title-here >
author: < name-here >
date: YYY-MM-DD
template: article.jade
---
Short summary here
@ -55,24 +38,14 @@ If you would like to contribute an article to http://theworstprogrammerever.com:
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/<name-here>.json`
1. Format for `<name-here>.json` should be:
```json
{
"name": "< name here > ",
"website": "< link-to-site-or-github > "
}
```
4. Create a pull request to this repo to await review/merge
5. Profit
3. Create a pull request to this repo to await review/merge
4. Profit
# License
< a rel = "license" href = "http://creativecommons.org/licenses/by-sa/4.0/" > < img
alt="Creative Commons License" style="border-width:0"
src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" />< / a > < br / > This work
is licensed under a < a rel = "license"
href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons
Attribution-ShareAlike 4.0 International License< / a > .
< a rel = "license" href = "http://creativecommons.org/licenses/by-sa/4.0/" >
< img alt = "Creative Commons License" style = "border-width:0" src = "https://i.creativecommons.org/l/by-sa/4.0/88x31.png" / >
< / a >
< br / >
This work is licensed under a < a rel = "license" href = "http://creativecommons.org/licenses/by-sa/4.0/" > Creative Commons Attribution-ShareAlike 4.0 International License< / a > .
