Csound Project Homepage
Csound Document JavaScript HTML CSS Csound Python Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
CsoundRealtimeExamples
_data commas May 14, 2018
_includes
_layouts [+] <h4>About</h4> to footer Dec 8, 2016
_posts added release news post for 6.11.0 May 10, 2018
csound30 Updating my real-time examples Sep 26, 2017
css fix for mixed-content error May 11, 2018
docs Updated manual release notes for 6.11.0 May 11, 2018
fonts
icsc2015 [fix] concert entries Sep 29, 2015
icsc2017 revised pdf program Nov 13, 2017
images added image for csound book Jul 9, 2018
scripts added search box functionality (needs restyling) Dec 17, 2015
waaw
wasm
.gitignore Added Soundpipe to project page Jan 16, 2018
CNAME Create CNAME May 10, 2018
Gemfile updated Gemfile and lock for latest dependencies and to work on Windows May 4, 2016
README.md updated info for newer Jekyll May 8, 2016
_config.yml Commited by RunloopPages on 2016-08-23 06:42:00 +0000 Aug 23, 2016
about.html [+] add redirect to get-started from about and documentation pages Dec 2, 2016
android.md added Brina Redfern's Android journal article and updated menu for 'c… Oct 22, 2015
api.md fixed broken links thanks to a hint of jared beckham Oct 23, 2017
archive.html Moved to WorkScout template Oct 18, 2015
atom.xml [fix] atom/rss nil template warning Sep 26, 2016
books.md
categories.html Moved to WorkScout template Oct 18, 2015
community.md Cleaned up community page Jan 15, 2018
conferences.md links and final touches Oct 25, 2017
contribute.md Fixed formatting bug on create page Jan 16, 2018
create.md Fixed formatting bug on create page Jan 16, 2018
csound_for_android_privacy.html Create csound_for_android_privacy.html Feb 8, 2017
documentation.html [+] add redirect to get-started from about and documentation pages Dec 2, 2016
download.md small fix May 22, 2018
frontends.md add csound-mode to frontends Jan 20, 2018
get-started.md Fix header in Markdown Mar 31, 2018
index.html Typos May 6, 2018
listen.md Replace broken Soundcloud widget with a couple of working links. Oct 23, 2017
news.html Added post for Csound Summer School May 8, 2016
olderversions.md more infos about older versions May 22, 2018
projects.html [+] projects section #32 Nov 21, 2015
rss.xml [fix] atom/rss nil template warning Sep 26, 2016
sitemap.txt
trycsound.html select browser Oct 5, 2014
udo.md Moved to WorkScout template Oct 18, 2015

README.md

csound.github.io

This Git repository holds the source code for the csound.github.io website, found at http://csound.github.io. The source is made up of Markdown (.md) files, which hold the content for pages and posts. These files are further processed by Jekyll, together with template files, to generate the final HTML site.

How to contribute

This site is an open-source, collaborative project. The Csound community is encouraged to contribute to the maintenance of the site by adding news posts, modifying pages, updating the structure of the site, and developing the style of the pages. The following describes how to perform these tasks. These tasks may be performed directly by members of the site maintainers team, or indirectly via pull request by third parties.

Users who would like to contribute, but who are not comfortable with the technical details to make a direct contribution, are encouraged to either file an issue on the issue tracker describing the news entry or requested change, or contact one of the site maintainers who will work to evaluate and integrate any changes.

Adding a News post

News posts are created using Markdown files placed in the _posts folder. Each post must have a header that states the title, categories, layout, and date of the post. (For news, the layout should be "post".) After the header, news is written using standard Markdown text. Images and other content may be put into the post by using standard HTML content (i.e. for images, use the image tag). The actual image should be placed in the images folder. If you have a question, it may help to look at one of the existing posts to use as a reference.

Modifying Pages

Pages are also Markdown files. They require headers that specify the layout (most should use "default") and title. Top-level pages are found in the root of the Git repository. Pages may also be placed in sub-folders. The pages must be linked to in some way for users to access them. This is generally done by modifying one of the templates in the _templates or _includes folder.

New pages can be made by copying one of the existing pages and updating it for the new content. Existing pages may be modified locally and pushed to the repository, or submitted as a change via pull request. Pages may also be modified directly through the GitHub project site, which allows modifying the page within the browser. Users can navigate to the file in the project, select the edit button, then finish the edit.

Modifying the site structure

The structure of the site is organized through the links of the navigation. The links are placed in the _templates and _includes so that they are shared by all pages and posts. To modify the structure, update one of the template files.

Modifying the site theme

The theme of the site is controlled via the HTML structure of the content and Cascading Style Sheets (CSS). Javascript is also used to help modify the feel and function of the site. The CSS and Javascript files used for the site are found in the css and js folders, respectively. These files are included into the site through the template files.

The site currently uses Bootstrap as the foundation for its theme. Site maintainers are free to continue using Bootstrap or replace it should they find a better solution.

Editing the Site Locally

Requirements

  1. Ruby
  2. RubyGems - most ruby distributions should come with gem installed
  3. Bundler - install using gem install bundler

Instructions

First, make a clone of the project locally:

git clone git://github.com/csound/csound.github.io.git
cd csound.github.io

From this directory, run Bundler to install the required gems:

bundle install

This installed the github-pages gem.

To view the site locally with jekyll, run:

bundle exec jekyll serve -I

This will start up a jekyll server. You can view the pages as they are rendered by Jekyll in your browser at:

http://localhost:4000

Also, with the -I flag, anytime you change a page, you can view the updates by refreshing the browser.