OSU-platform suggests to use GitHub.com as a tool for colaboration. Despite the fact, that GitHub dedicated primarily for programmers, it can be used to store not only software source code but also texts, images, etc. If you are not familiar with GitHub, you may read following articles:
You must have a GitHub account in order to follow the instructions.
OSU-platform provides a template repository to facilitate open design sharing. To find it, type “opensourceurbanism” in the search field.
You will find several repositories. Click on the repository “opensourceurbanism/template”
As an alternative, click the link on template
Click on the button “Fork” on the top-right corner of the template page. This action will copy template repository into your GitHub account. Now you can edit it as you wish. Changes will not affect the original template.
As you may see, your new repository labeled “forked from opensourceurbanism/template”.
To upload your project files (pictures, instructions, and so on) you may use the button “Upload files” or simply drag-and-drop files and folders.
General information about project description - Guidlines for Sensors
The file README.md contains a description template. To change it, click on README.md link and on the icon depicting a pencil.
Github uses Markdown language for text formatting. Its syntax is lightweight and simple, please, read the Markdown Guide.
You can check how your page looks like by clicking on “Preview changes”. Red lines on the left depict deleted information, green ones show what you've added, and yellow ones show changes in the text.
To save information on the repository you should commit changes! Press the button on the bottom of “Edit file” tab (the same actions as in the previous section).
To change the repository name on something more appealing, go to “Settings” tab, chose new name for your project and save changes.
Go to “Settings” tab and scroll to “GitHub Pages” section. Choose “master branch” from the dropdown list and save changes. Press “Change theme” button and choose a preferable one. After that, you will see your webpage address.
Congratulations! Now you have not only a project repository that anyone can copy and enhance but also a nice project page.
The idea behind OSU is non-hierarchical peer production of urban design, therefore you can share your repository page as you like. If you wish your project to have appeared in the catalog on https://opensourceurbanism.io/projects/ you must send us your repository page for pre-moderation.
Go to the catalog page and click on the “Add your project” button.
Fill in fields in the popup window. Paste your repository address from step 6. Once all fields filled in click on “Send” button. We will add your project after a revision. In any case, we will contact you via e-mail.