larkumlab
/
Dealing_with_Gin


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
							<!DOCTYPE html>
<html lang="" xml:lang="">
<head>

  <meta charset="utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <title>5 Browsing a repository | dealing with gin</title>
  <meta name="description" content="5 Browsing a repository | dealing with gin" />
  <meta name="generator" content="bookdown 0.17 and GitBook 2.6.7" />

  <meta property="og:title" content="5 Browsing a repository | dealing with gin" />
  <meta property="og:type" content="book" />
  
  
  <meta name="twitter:card" content="summary" />
  <meta name="twitter:title" content="5 Browsing a repository | dealing with gin" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <meta name="apple-mobile-web-app-capable" content="yes" />
  <meta name="apple-mobile-web-app-status-bar-style" content="black" />
  
  
<link rel="prev" href="dashboard-how-to-use.html"/>
<link rel="next" href="downloading-files.html"/>
<script src="libs/jquery-2.2.3/jquery.min.js"></script>
<link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-table.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-clipboard.css" rel="stylesheet" />


</head>

<body>


  <div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">

    <div class="book-summary">
      <nav role="navigation">

<ul class="summary">
<li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Dealing with Gin</a></li>
<li class="chapter" data-level="2" data-path="play-with-sandbox.html"><a href="play-with-sandbox.html"><i class="fa fa-check"></i><b>2</b> Play with Sandbox</a></li>
<li class="chapter" data-level="3" data-path="cannot-see-a-repository.html"><a href="cannot-see-a-repository.html"><i class="fa fa-check"></i><b>3</b> Cannot see a repository?</a><ul>
<li class="chapter" data-level="3.1" data-path="cannot-see-a-repository.html"><a href="cannot-see-a-repository.html#sign-in-to-gin"><i class="fa fa-check"></i><b>3.1</b> Sign in to Gin</a></li>
<li class="chapter" data-level="3.2" data-path="cannot-see-a-repository.html"><a href="cannot-see-a-repository.html#check-that-the-repository-exists"><i class="fa fa-check"></i><b>3.2</b> Check that the repository exists</a></li>
<li class="chapter" data-level="3.3" data-path="cannot-see-a-repository.html"><a href="cannot-see-a-repository.html#make-sure-you-have-access-to-the-repository"><i class="fa fa-check"></i><b>3.3</b> Make sure you have access to the repository</a></li>
</ul></li>
<li class="chapter" data-level="4" data-path="dashboard-how-to-use.html"><a href="dashboard-how-to-use.html"><i class="fa fa-check"></i><b>4</b> Dashboard: how to use</a><ul>
<li class="chapter" data-level="4.1" data-path="dashboard-how-to-use.html"><a href="dashboard-how-to-use.html#activity"><i class="fa fa-check"></i><b>4.1</b> Activity</a></li>
<li class="chapter" data-level="4.2" data-path="dashboard-how-to-use.html"><a href="dashboard-how-to-use.html#collaborative-repositories"><i class="fa fa-check"></i><b>4.2</b> Collaborative repositories</a></li>
<li class="chapter" data-level="4.3" data-path="dashboard-how-to-use.html"><a href="dashboard-how-to-use.html#private-repositories"><i class="fa fa-check"></i><b>4.3</b> Private repositories</a></li>
</ul></li>
<li class="chapter" data-level="5" data-path="browsing-a-repository.html"><a href="browsing-a-repository.html"><i class="fa fa-check"></i><b>5</b> Browsing a repository</a><ul>
<li class="chapter" data-level="5.1" data-path="browsing-a-repository.html"><a href="browsing-a-repository.html#overview-of-the-repository"><i class="fa fa-check"></i><b>5.1</b> Overview of the repository</a></li>
<li class="chapter" data-level="5.2" data-path="browsing-a-repository.html"><a href="browsing-a-repository.html#browsing-files"><i class="fa fa-check"></i><b>5.2</b> Browsing files</a><ul>
<li class="chapter" data-level="5.2.1" data-path="browsing-a-repository.html"><a href="browsing-a-repository.html#a-small-side-note"><i class="fa fa-check"></i><b>5.2.1</b> A small side note</a></li>
</ul></li>
</ul></li>
<li class="chapter" data-level="6" data-path="downloading-files.html"><a href="downloading-files.html"><i class="fa fa-check"></i><b>6</b> Downloading files</a><ul>
<li class="chapter" data-level="6.1" data-path="downloading-files.html"><a href="downloading-files.html#download-button"><i class="fa fa-check"></i><b>6.1</b> Download button</a></li>
</ul></li>
<li class="chapter" data-level="7" data-path="uploading-files.html"><a href="uploading-files.html"><i class="fa fa-check"></i><b>7</b> Uploading files</a><ul>
<li class="chapter" data-level="7.1" data-path="uploading-files.html"><a href="uploading-files.html#location-of-the-buttons"><i class="fa fa-check"></i><b>7.1</b> Location of the buttons</a></li>
<li class="chapter" data-level="7.2" data-path="uploading-files.html"><a href="uploading-files.html#common-features-for-file-upload"><i class="fa fa-check"></i><b>7.2</b> Common features for file-upload</a><ul>
<li class="chapter" data-level="7.2.1" data-path="uploading-files.html"><a href="uploading-files.html#specifying-the-directory-to-be-uploaded"><i class="fa fa-check"></i><b>7.2.1</b> Specifying the directory to be uploaded</a></li>
<li class="chapter" data-level="7.2.2" data-path="uploading-files.html"><a href="uploading-files.html#committing-new-files"><i class="fa fa-check"></i><b>7.2.2</b> Committing new files</a></li>
</ul></li>
<li class="chapter" data-level="7.3" data-path="uploading-files.html"><a href="uploading-files.html#uploading-a-set-of-files"><i class="fa fa-check"></i><b>7.3</b> Uploading a set of files</a></li>
<li class="chapter" data-level="7.4" data-path="uploading-files.html"><a href="uploading-files.html#create-a-new-text-file"><i class="fa fa-check"></i><b>7.4</b> Create a new (text) file</a></li>
<li class="chapter" data-level="7.5" data-path="uploading-files.html"><a href="uploading-files.html#edit-a-text-file"><i class="fa fa-check"></i><b>7.5</b> Edit a (text) file</a></li>
</ul></li>
<li class="chapter" data-level="8" data-path="using-application-made-for-git.html"><a href="using-application-made-for-git.html"><i class="fa fa-check"></i><b>8</b> Using application made for git</a></li>
<li class="chapter" data-level="9" data-path="using-rstudio-with-gin.html"><a href="using-rstudio-with-gin.html"><i class="fa fa-check"></i><b>9</b> Using Rstudio with GIN</a></li>
</ul>

      </nav>
    </div>

    <div class="book-body">
      <div class="body-inner">
        <div class="book-header" role="navigation">
          <h1>
            <i class="fa fa-circle-o-notch fa-spin"></i><a href="./">dealing with gin</a>
          </h1>
        </div>

        <div class="page-wrapper" tabindex="-1" role="main">
          <div class="page-inner">

            <section class="normal" id="section-">
<div id="browsing-a-repository" class="section level1">
<h1><span class="header-section-number">5</span> Browsing a repository</h1>
<p>If you visit the repository page, it looks like below:</p>
<div class="figure">
<img src="images/repository-top.png" alt="A typical repository page" />
<p class="caption">A typical repository page</p>
</div>
<p>From here, you can browse what is in the repository including:</p>
<ol style="list-style-type: decimal">
<li><a href="browsing-a-repository.html#overview-of-the-repository">overview of the repository</a></li>
<li><a href="browsing-a-repository.html#browsing-files">file contents</a></li>
</ol>
<div id="overview-of-the-repository" class="section level2">
<h2><span class="header-section-number">5.1</span> Overview of the repository</h2>
<p>On top of the page, you will find the header consisting of <code>&lt;owner name&gt;/&lt;repository name&gt;</code>:</p>
<div class="figure">
<img src="images/repository-title.png" alt="Repository name" />
<p class="caption">Repository name</p>
</div>
<p>This represents the <em>identifier</em> of the repository so that
you can specify a single repository inside <code>https://gin.g-node.org</code>.</p>
<p>Down to the bottom, you may find some document:</p>
<div class="figure">
<img src="images/readme.png" alt="README file" />
<p class="caption">README file</p>
</div>
<p>This represents the (hopefully) detailed description of the repository about what it is
or what it contains.</p>
<blockquote>
<p>In fact, this description comes from the <code>README.md</code> file in the root directory of the repository.
The name of the file comes from a tradition of programmers community to contain the “read-me-first”
file in the top directory of any code.</p>
<p>You can add or edit it by adding / editing the <code>README.md</code> file.</p>
<p>Even inside the sub-directories of the repositories, the description will automatically show up
if you add and edit a <code>README.md</code> file in it.</p>
</blockquote>
</div>
<div id="browsing-files" class="section level2">
<h2><span class="header-section-number">5.2</span> Browsing files</h2>
<p>In the middle, you can find a list of files and directories in the repository:</p>
<div class="figure">
<img src="images/files.png" alt="File list" />
<p class="caption">File list</p>
</div>
<p>By clicking on individual file/directory entry, you can browse its contents.</p>
<p>For example, you can see the contents of a sub-directory by clicking on it:</p>
<div class="figure">
<img src="images/directory-view.png" alt="Directory view" />
<p class="caption">Directory view</p>
</div>
<p>Contents of normal files may be visible, as long as your browser supports it.</p>
<ul>
<li><p>For example, you can browse to <a href="images/dashboard.png">web-interface/images/dashboard.png</a>,
and you can have a glimpse of the original image file:
<img src="images/image-view.png" alt="Image-file view" /></p></li>
<li><p>If you write the documents in the <a href="https://www.markdownguide.org/getting-started">Markdown</a> format
(and I recommend to do so whenever possible), you can see the formatted-view of the document:
<img src="images/markdown-view.png" alt="Markdown view" /></p></li>
<li>Other text-based files (CSV, TSV etc.) may be seen in its raw format.</li>
<li><p>Binary files (Excel, Word, Spike2 etc.) will not be visible, so you must <a href="downloading.md">download it</a> to see the contents.</p></li>
</ul>
<div id="a-small-side-note" class="section level3">
<h3><span class="header-section-number">5.2.1</span> A small side note</h3>
<p>On the left columns of the files list, you can see some information like below:</p>
<div class="figure">
<img src="images/commit-description.png" alt="Commit description" />
<p class="caption">Commit description</p>
</div>
<p>Sadly <strong>it is <em>not</em> about the description to the file itself</strong> but describes the commit
that updated this file most recently.</p>
<p>In the case of the image above, the directory “web-interface” was updated by the commit
with the commit ID being <code>b42b7633f7</code>, and with the commit message <code>update dashboard.md</code>.</p>

</div>
</div>
</div>
            </section>

          </div>
        </div>
      </div>
<a href="dashboard-how-to-use.html" class="navigation navigation-prev " aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
<a href="downloading-files.html" class="navigation navigation-next " aria-label="Next page"><i class="fa fa-angle-right"></i></a>
    </div>
  </div>
<script src="libs/gitbook-2.6.7/js/app.min.js"></script>
<script src="libs/gitbook-2.6.7/js/lunr.js"></script>
<script src="libs/gitbook-2.6.7/js/clipboard.min.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
<script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-clipboard.js"></script>
<script>
gitbook.require(["gitbook"], function(gitbook) {
gitbook.start({
"sharing": {
"github": false,
"facebook": true,
"twitter": true,
"linkedin": false,
"weibo": false,
"instapaper": false,
"vk": false,
"all": ["facebook", "twitter", "linkedin", "weibo", "instapaper"]
},
"fontsettings": {
"theme": "white",
"family": "sans",
"size": 2
},
"edit": {
"link": null,
"text": null
},
"history": {
"link": null,
"text": null
},
"view": {
"link": null,
"text": null
},
"download": null,
"toc": {
"collapse": "subsection"
}
});
});
</script>

</body>

</html>