-
Notifications
You must be signed in to change notification settings - Fork 4
Home
We would like to have a way to document projects occurring in the Computational Experiences for Undergraduates project. We have decided to create this repository, which has:
-
github pages: An automatically generated github page (see here ) that coverts the Readme.md file of this project to a a public web page at [http://djyaron.github.io/compreu/].
-
github wiki: A wiki that is part of the overall repository (see here).
The github page has a list of projects that link to the appropriate project page in the wiki. These links start with:
https://github.com/djyaron/compreu/wiki/
So a page with the name "prov" in the wiki, will be:
https://github.com/djyaron/compreu/wiki/prov
as an external link. Within a wiki page, you can link to other pages of the wiki by just starting at "wiki", e.g.
wiki/prov
You have two choices
-
Edit from within github (go to the repository, and click on wiki in the sidebar on the right)
-
Checkout the wiki using the following command
git clone git@github.com:djyaron/compreu.wiki.git
Github uses markdown, a popular wiki format with many webpages and editors. I use MarkdownPad 2 on windows. You can also go to a site such as [http://dillinger.io/], which allows you to edit in one window and view the translated version in another window.
We would like each page to have:
- Short introduction of the goals of the project
- List of resources being used, including
- link to a mendeley folder of relevant references [http://www.mendeley.com/]
- Link to any other relevant githup repos, including the private ones discussed in the next section
- google drive or other filesystem where results are located
See [wiki/githubAdvice.md] for a general overview of how we use github to manage code projects.
We will probably use a single private repo to handle all of the results people do not yet want to share publicly. We will insert instructions here once we figure out the details.