Skip to content
jeffblank edited this page Feb 27, 2015 · 1 revision

Welcome to the Wiki of the Protection Profile for Web Browsers

Where's the Current Document?

A live rendering of the Protection Profile, hosted on OpenShift, is available in several forms:

It is updated every minute based on the most recent push to GitHub.

How Can I Develop and Contribute?

1. Install any development tools needed by your platform:
2. Install the pre-commit git hooks which will check that all commits have a column width of less then 100 chars. This will help keep the formatting looking good on the github web site. You need to run install_hooks.sh to install the hooks into the .git/hooks folder.
For Windows
Download the latest Git Client for Windows. Additionally it would be useful to have a decent XML Editor. Oxygen is one option. A free open source alternative is XML Notepad which works well but does require the .NET 2.0 Framework to be installed.
For Mac OS X
Install XCode, and possibly also the Command Line Tools package. XCode is available on the Mac App store. Instructions for installing the Command Line Tools package (dependent on version of Mac OS X) are provided inside XCode. This site also provides info on installing the open source tools, though these are not the Apple-supported versions.
For Red Hat Enterprise Linux
This should work out-of-the-box with most basic installations. If not, install git using yum.
2. Clone repo:
Create and/or change to a working directory where you would like to store a local clone of the repository.
git clone https://github.com/commoncriteria/webbrowser.git
The rest of these instructions assume that the directory hosting this clone is the current working directory.
3. Configure remote URL:
HTTPS
git remote set-url origin https://[your GitHub username]@github.com/commoncriteria/webbrowser.git -- prompts for your GitHub password
SSH
TO DO: Add instructions for configuring remote SSH URL.
See Which remote URL should I use? for a summary of these alternatives.
4. Make changes, update repo, etc.:
You're on your own here. See Git Basics - Working with Remotes for a summary of basic commands.
5. Make Project:
Build the code from within the project directory using the make command. If everything built successfully there should be three html files within the output directory.
6. Commit changes:
git add [changed files]
git rm [files to delete] -- use with caution as this will delete local and remote copies
git commit -- updates local repository; prompts for change comments
git push origin master -- updates remote repository; prompts for password
That's it. Go forth and do good things...