Giter Club home page Giter Club logo

opencast-usersguide's Introduction

Overview

This guide is the official Opencast user's manual for the open source video capture system.

Setup

Git Repository

The source documentation is hosted on this Git repository: https://bitbucket.org/opencast-community/matterhorn

Building Locally

The documentation is written in standard markdown. The tool that is used to build the documentation is mkdocs.org

In order to build the documentation locally, you will need to install MkDocs. Check out the documentation or use the following command

$ pip install mkdocs

From there, download the source of the documentation, go to the repo and use the following command to start a simple http server and build the doc:

$ mkdocs serve

Dependencies and Requirements

  • Python
  • mkdocs

Editing on dillinger.io

In order to edit from Dillinger.io, you will need to connect your github account to Dillinger. See the left nav to do that. Once you have connected your github account, use Import From link on the top nav to import the file you want to edit (you can't import all files at the same time, but might be a good feature request).

Once you are done editing your file, just use the "Save to" link on the top nav and it will commit the changes to the github repo.

That's it!

Now go to the github repo and checkout the commit history. You will see that all everytime a "Save to Github" is done, a commit is done on github - that's the magic!

PS: We may also check out other editors - like stackedit - which could allow to see all the files at once.

Editing on Github

Of course there is always the alternative way of editing on Github directly (as I do now).

opencast-usersguide's People

Contributors

aubort avatar calisurf avatar

Watchers

James Cloos avatar  avatar

Forkers

calisurf

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.