diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..93f1361 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +npm-debug.log diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..58f97f6 --- /dev/null +++ b/Makefile @@ -0,0 +1,19 @@ +prepublish: index.html +start: prepublish + http-server + +index.html: Readme.md head.html foot.html package.json Makefile + cat head.html > build.html + ## Change <project name> to This + sed 's/<project name>/This/g' Readme.md >> build.md + marked -i build.md >> build.html + rm build.md + cat foot.html >> build.html + mv build.html index.html + + +clean: + -rm index.html + -rm build.html + +.PHONY: prepublish start clean diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..c5b6f84 --- /dev/null +++ b/Readme.md @@ -0,0 +1,31 @@ +# <project name> is an [OPEN Open Source Project](http://openopensource.org/) + +----------------------------------------- + +## What? + +Individuals making significant and valuable contributions are given +commit-access to the project to contribute as they see fit. This project +is more like an open wiki than a standard guarded open source project. + +## Rules + +There are a few basic ground-rules for contributors: + +1. **No `--force` pushes** or modifying the Git history in any way. +1. **Non-master branches** ought to be used for ongoing work. +1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. +1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. +1. Contributors should attempt to adhere to the prevailing code-style. + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer. + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be +subject to pull-requests or changes by contributors where you believe +you have something valuable to add or change. + +Get a copy of this manifesto as [markdown](https://raw.githubusercontent.com/openopensource/openopensource.github.io/master/Readme.md) and use it in your own projects. diff --git a/foot.html b/foot.html new file mode 100644 index 0000000..308b1d0 --- /dev/null +++ b/foot.html @@ -0,0 +1,2 @@ +</body> +</html> diff --git a/head.html b/head.html new file mode 100644 index 0000000..cc7c624 --- /dev/null +++ b/head.html @@ -0,0 +1,9 @@ +<!doctype html> +<html> +<head> + <title>OPEN Open Source</title> + <link href='http://fonts.googleapis.com/css?family=Ubuntu:300,500' rel='stylesheet' type='text/css'> + <link href='style.css' rel='stylesheet' type='text/css'> +</head> +<body> +<a href="https://github.com/openopensource/openopensource.github.io"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a> diff --git a/index.html b/index.html index 88c14ea..48bc222 100644 --- a/index.html +++ b/index.html @@ -3,35 +3,32 @@ <head> <title>OPEN Open Source</title> <link href='http://fonts.googleapis.com/css?family=Ubuntu:300,500' rel='stylesheet' type='text/css'> - <style> - -body { - font-family: 'Ubuntu', sans-serif; - background: #f0f0f8; - color: #404050; -} - -h1, h2, h3, p { - max-width: 700px; - margin: 0 auto; -} - -h1 { - font-weight: 300; - letter-spacing: 0.2em; - text-align: center; - max-width: 700px; - margin: 2em auto; - padding-bottom: 0.4em; - border-bottom: solid 1px #333; -} - - </style> + <link href='style.css' rel='stylesheet' type='text/css'> </head> <body> - -<h1 id="open-open-source">OPEN Open Source</h1> -<h2 id="work-in-progress">work in progress</h2> +<a href="https://github.com/openopensource/openopensource.github.io"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a> +<h1 id="this-is-an-open-open-source-project-http-openopensource-org-">This is an <a href="http://openopensource.org/">OPEN Open Source Project</a></h1> +<hr> +<h2 id="what-">What?</h2> +<p>Individuals making significant and valuable contributions are given +commit-access to the project to contribute as they see fit. This project +is more like an open wiki than a standard guarded open source project.</p> +<h2 id="rules">Rules</h2> +<p>There are a few basic ground-rules for contributors:</p> +<ol> +<li><strong>No <code>--force</code> pushes</strong> or modifying the Git history in any way.</li> +<li><strong>Non-master branches</strong> ought to be used for ongoing work.</li> +<li><strong>External API changes and significant modifications</strong> ought to be subject to an <strong>internal pull-request</strong> to solicit feedback from other contributors.</li> +<li>Internal pull-requests to solicit feedback are <em>encouraged</em> for any other non-trivial contribution but left to the discretion of the contributor.</li> +<li>Contributors should attempt to adhere to the prevailing code-style.</li> +</ol> +<h2 id="releases">Releases</h2> +<p>Declaring formal releases remains the prerogative of the project maintainer.</p> +<h2 id="changes-to-this-arrangement">Changes to this arrangement</h2> +<p>This is an experiment and feedback is welcome! This document may also be +subject to pull-requests or changes by contributors where you believe +you have something valuable to add or change.</p> +<p>Get a copy of this manifesto as <a href="https://raw.githubusercontent.com/openopensource/openopensource.github.io/master/Readme.md">markdown</a> and use it in your own projects.</p> </body> </html> diff --git a/index.md b/index.md deleted file mode 100644 index 94a8afe..0000000 --- a/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# OPEN Open Source - -## work in progress diff --git a/package.json b/package.json index f9ddc3b..bf7e26b 100644 --- a/package.json +++ b/package.json @@ -3,9 +3,12 @@ "version": "0.0.0", "description": "http://openopensource.org", "scripts": { - "start": "node -e \"fs = require('fs'); b = require('brucedown'); b(fs.readFileSync(__dirname + '/index.md', 'utf8'), function (err, html) { if (err) throw err; fs.writeFileSync('index.html',fs.readFileSync('index.html', 'utf8').replace(/<body>[\\\\s\\\\S]*<\\\\/body>/gmi, '<body>\\\\n\\\\n' + html + '\\\\n</body>'), 'utf8') });\"" + "prepublish": "make prepublish", + "start": "make start", + "clean": "make clean" }, - "dependencies": { - "brucedown": "^0.1.1" + "devDependencies": { + "http-server": "^0.8.0", + "marked": "^0.3.3" } } diff --git a/style.css b/style.css new file mode 100644 index 0000000..10734b9 --- /dev/null +++ b/style.css @@ -0,0 +1,33 @@ +html, body { + margin: 0; + padding: 0; +} + +body { + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + font-family: 'Ubuntu', sans-serif; + background: #f0f0f8; + color: #404050; + max-width: 800px; + max-width: 40vw; + margin: 0 auto; + font-weight: 300; + font-size: 1.2em; +} + +h1 { + letter-spacing: 0.2em; + text-align: center; + max-width: 700px; + margin: 1em auto; +} + +a { + color: #4cb5ff; + text-decoration: none; +} + +a:hover { + color: #acd5ff; +}