index.html 7.42 KB
Newer Older
1 2 3 4 5 6
<!DOCTYPE html>
<html lang="en">
    <head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
Marvin Scholz's avatar
Marvin Scholz committed
7
    <link rel="canonical" href="http://epirat.pages.videolan.net/devdocs/intro/">
8 9

    <!-- Bootstrap CSS -->
Marvin Scholz's avatar
Marvin Scholz committed
10
    <link rel="stylesheet" href="/devdocs/assets/css/main.css">
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

    <style>
        :root {
          --jumbotron-padding-y: 3rem;
        }

        .jumbotron {
          padding-top: var(--jumbotron-padding-y);
          padding-bottom: var(--jumbotron-padding-y);
          margin-bottom: 0;
          background-color: #fff;
        }
        @media (min-width: 768px) {
          .jumbotron {
            padding-top: calc(var(--jumbotron-padding-y) * 2);
            padding-bottom: calc(var(--jumbotron-padding-y) * 2);
          }
        }

        .jumbotron p:last-child {
          margin-bottom: 0;
        }

        .jumbotron-heading {
          font-weight: 300;
        }

        .jumbotron .container {
          max-width: 40rem;
        }
    </style>

    <title>Introduction</title>
    <meta name="description" content="Documentation for VLC developers and those who want to get started contributing to VLC.
">
</head>
    <body>
        <nav class="navbar navbar-expand-md navbar-dark bg-dark mb-4">
    <a class="navbar-brand" href="#">
        <img src="https://images.videolan.org/images/VLC-IconSmall.png" width="30" height="30" class="d-inline-block align-top" alt="VLC"> Developer Docs
    </a>
    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
        <span class="navbar-toggler-icon"></span>
    </button>
    <div class="collapse navbar-collapse" id="navbarCollapse">
        <ul class="navbar-nav mr-auto">
            <li class="nav-item active">
                <a class="nav-link" href="#">Overview <span class="sr-only">(current)</span></a>
            </li>
            <li class="nav-item">
61
                <a class="nav-link" href="/devdocs/intro/">Introduction</a>
62 63 64 65 66 67
            </li>
            <li class="nav-item">
                <a class="nav-link" href="#">Documentation</a>
            </li>
            <!--
                <li class="">
Marvin Scholz's avatar
Marvin Scholz committed
68
                    <a href="/devdocs/about">About</a>
69 70 71 72 73 74
                </li>
            -->
        </ul>
    </div>
</nav>

Marvin Scholz's avatar
Marvin Scholz committed
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
        <main role="main" class="container">
            <h1 class="display-4">Introduction</h1>

            <p class="lead">
    This is a quick introduction into VLC development, how to communicate and
    coordinate with the other developers, get the source code and how to 
    submit your changes back.
</p>

<h2 id="communicating">Communicating</h2>
<p>The most important part is how to communicate with other VLC developers.</p>

<h3 id="chat-irc">Chat (IRC)</h3>
<p>A lot of communication happens via Internet Relay Chat (IRC) on the <em>#videolan</em>
chatroom (“channel”) on <a href="https://freenode.net">Freenode</a>. To join the chat you
can either use a IRC client program or the Webchat. The recommended way is to
use a IRC client program as it makes it easier to stay connected and online in
the chat for longer time.</p>

<p>Popular clients are:
<a href="https://hexchat.github.io">HexChat</a> (Windows/Linux/macOS),
<a href="https://quassel-irc.org">Quassel IRC</a> (Windows/Linux/macOS),
<a href="https://www.codeux.com/textual/">Textual</a> (macOS).</p>

<p class="text-center">
    <a href="http://webchat.freenode.net/?channels=%23videolan&amp;uio=MTY9dHJ1ZSYzPWZhbHNlJjk9dHJ1ZSYxMT0yMDUmMTM9dHJ1ZSYxNT10cnVl1d" class="btn btn-primary my-2">Open Webchat</a>
    <a href="irc://freenode.net:6667/#videolan" class="btn btn-secondary my-2">Direct Link</a>
</p>

<h3 id="mailinglist-ml">Mailinglist (ML)</h3>
<p>For longer discussions and to follow the overall development, there is
the <a href="https://mailman.videolan.org/listinfo/vlc-devel">vlc-devel</a> mailinglist.
The mailing list is mostly used for submissions of source code patches and
review and discussion of these patches. Additionally important announcements
are made on this list, so it is strongly recommended to subscribe to that list.</p>

<p>All emails to that list are <a href="https://mailman.videolan.org/pipermail/vlc-devel/">publicly archived</a> and can be
browser using a web interface. Patches sent to that list will be additionally
available on <a href="https://patches.videolan.org">Patchwork</a>.</p>

<p class="text-center">
    <a href="https://mailman.videolan.org/listinfo/vlc-devel" class="btn btn-primary my-2">
        Subscribe the List
    </a>
    <a href="https://mailman.videolan.org/pipermail/vlc-devel/" class="btn btn-secondary my-2">
        Browse archives
    </a>
</p>

<h3 id="bugtracker-trac">Bugtracker (Trac)</h3>
<p>To keep track of all Bugreports and to plan Milestones, VLC currently has a
<a href="https://trac.videolan.org/vlc">Trac instance</a>.
There tickets can be created for bugs or feature requests, and it is a good
place to find things to work on.</p>

<p>Before filing new bugs, make sure you’ve read the bug report guidelines
which detail how to write a useful report and which information need
to be in it and how to obtain them.</p>

<p class="text-center">
    <a href="./docs/report_bugs.html" class="btn btn-primary my-2">Report Guide</a>
    <a href="https://trac.videolan.org/vlc/report/3" class="btn btn-secondary my-2">Browse Tickets</a>
</p>

<hr />

<h2 id="getting-the-source">Getting the Source</h2>
<p>If you want to contribute code to VLC, you need to get familiar with how to
get the source code. All VideoLAN projects use the <a href="https://git-scm.com">Git SCM</a> for their
code. In case you are not familiar with git yet, make sure you get a basic
understanding about how Git works before you continue, as this is essential
and not covered by this developer documentation.</p>

<p>Most VideoLAN projects are nowadays hosted at the
<a href="https://code.videolan.org">VideoLAN GitLab</a> instance, some projects, noticeably VLC
itself is still hosted on the old Git server at <code class="highlighter-rouge">git.videolan.org</code>
and can be browsed using the <a href="https://git.videolan.org/">Gitweb interface</a>.
For more information about the Git workflow for VLC check out the
dedicated Git page.</p>

<p class="text-center">
    <a href="#TODO" class="btn btn-primary my-2">Git Guide</a>
</p>

<h2 id="submitting-patches">Submitting patches</h2>
<p>Once you’ve worked on a feature or fixed a bug, to submit your code back you
need to send a patch to the mailinglist. The easiest way to do this is using
the <code><strong>git</strong> format-patch</code>
and <code><strong>git</strong> send-email</code> commands.
More details how to use them and which conventions we expect can be found
on the “Submitting patches” page.</p>

<p class="text-center">
    <a href="#TODO" class="btn btn-primary my-2">Submitting patches</a>
</p>


        </main>

        <!--
<footer class="footer">
	<div class="container">
		<p class="text-muted">These are unofficial Twitter API Docs, not in any way affiliated with Twitter.</p>
	</div>
</footer>
-->
        <!-- Optional JavaScript -->
        <!-- jQuery first, then Popper.js, then Bootstrap JS -->
Marvin Scholz's avatar
Marvin Scholz committed
184 185 186
        <script src="/devdocs/assets/js/jquery.slim.min.js"></script>
        <script src="/devdocs/assets/js/popper.min.js"></script>
        <script src="/devdocs/assets/js/bootstrap.min.js"></script>
187 188 189
    </body>

</html>