Skip to content

Commit 68e89c1

Browse files
committed
update readme
1 parent b0675b8 commit 68e89c1

10 files changed

+3159
-612
lines changed

README.md

Lines changed: 17 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,26 @@
1-
# Retina
21

3-
Retina is a free open source web application to share network visualizations online, without any server required. It is developed by [OuestWare](https://www.ouestware.com/en/) for [Tommaso Venturini](http://www.tommasoventurini.it/) from [CNRS Center Internet et Société](https://cis.cnrs.fr/). It is released under the [GNU GPLv3 license](https://gitlab.com/ouestware/retina/-/blob/main/LICENSE).
2+
<div align="center">
3+
<img src="./public/deepgit_logo.png" alt="WESE Logo" width="150">
4+
<h1 align="center">DeepGit</h1>
5+
</div>
46

5-
<p align="center">
6-
<img src="https://ouestware.gitlab.io/retina/beta/logo_CNRS_CIS.jpg" width="260" />
7-
<img src="https://ouestware.gitlab.io/retina/beta/logo_ouestware_text.svg" width="260" />
8-
</p>
9-
10-
You can see a running example [here](https://ouestware.gitlab.io/retina/beta/#/graph/?url=https%3A%2F%2Fouestware.gitlab.io%2Fretina%2Fbeta%2Fdataset.gexf&c=c&s=s&sa[]=s&sa[]=r&ca[]=t&ca[]=c&st[]=t&st[]=c&ds=1&dc=1), or try it with your own graphs at [ouestware.gitlab.io/retina](https://ouestware.gitlab.io/retina/).
11-
12-
## Features
13-
14-
Retina aims at helping people sharing interactive network maps online:
15-
16-
1. Graph _editors_ give Retina a graph file, and tell it how their graph file should be interpreted
17-
2. They share a link to their visualization with graph _explorers_
18-
3. Graph _explorers_ can then see the graph and interact with it
19-
20-
### Filtering
21-
22-
Users can filter nodes on their attributes. Retina tries to detect whether attributes represent quantitative, qualitative or textual information. Graph _editors_ can select which fields can be used to filter or not for graph _explorers_.
23-
24-
### Colors and sizes caption
25-
26-
In most graph file formats, nodes and edges can have colors and sizes of their own, but we cannot know how they have been determined. This makes it impossible to display a caption for the graph.
27-
28-
Retina allows mapping node colors on node attributes (in a way inspired by [Gephi](https://gephi.org/features/)), so that it can display a **proper caption**.
29-
30-
### Sharing
31-
32-
Graphs in Retina can be shared as classic links or special links to be embedded in iframes. An export can also disable all actions that modify the state (colors and size fields, filters) to the user, to share more of an "enhanced zoomable image" of the graph.
33-
34-
## How to use it
35-
36-
1. Open [Retina](https://ouestware.gitlab.io/retina/)
37-
2. Get some graph file (such as a [GEXF](https://gexf.net/) graph file from [Gephi](https://gephi.org/) for instance)
38-
3. Put it somewhere on the internet, so that you can have a public URL leading to it
39-
4. Go to [ouestware.gitlab.io/retina](https://ouestware.gitlab.io/retina)
40-
5. Click on `Online`
41-
6. Enter your GEXF file URL, and click on `Visualize`
7+
# Overview
8+
DeepGit is a free, open-source web application designed to help researchers and research software engineers discover and explore research software within specific domains.
429

43-
You can now fine tune some settings for viewers, and when you are ready click on the `Share` button on the top of the left panel.
4410

45-
You can now share the URL of the page to people, and they'll see the same network as you do.
4611

47-
## How to contribute
12+
# Acknowledgment
13+
<!-- DeepGit is a joint effort between the University of Illinois Urbana-Champaign's [Data Exploration Lab](https://github.com/data-exp-lab) and NumFOCUS's [Map of Open Source Science](https://www.opensource.science/moss)
4814
49-
Retina was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) using [TypeScript](https://www.typescriptlang.org/).
50-
51-
It uses [SASS](https://sass-lang.com/) for styles, and is based on [Bootstrap](https://getbootstrap.com/) for its base styles and its grid system, and [react-icons](https://react-icons.github.io/react-icons/) for icons.
52-
53-
Finally, the graphs are rendered using [sigma.js](https://www.sigmajs.org/) and [graphology](https://graphology.github.io/).
54-
55-
## Available Scripts
56-
57-
In the project directory, you can run:
58-
59-
### `npm start`
60-
61-
Runs the app in the development mode.
62-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
63-
64-
The page will reload if you make edits.
65-
You will also see any lint errors in the console.
66-
67-
### `npm test`
68-
69-
Launches the test runner in the interactive watch mode.
70-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
71-
72-
### `npm run build`
73-
74-
Builds the app for production to the `build` folder.
75-
It correctly bundles React in production mode and optimizes the build for the best performance.
76-
77-
The build is minified and the filenames include the hashes.
78-
Your app is ready to be deployed!
79-
80-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
15+
<p align="center">
16+
<img src="./public/dxl_logo.png" width="120" />
17+
<img src="./public/ossci_logo.jpg" width="120" />
18+
</p> -->
8119

82-
## Learn More
20+
DeepGit is built upon [Retina](https://ouestware.gitlab.io/retina/1.0.0-beta.4/#/) developed by [OuestWare](https://www.ouestware.com/en/)
8321

84-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
22+
# License
23+
The software is available under [GNU GPLv3 license](https://gitlab.com/ouestware/retina/-/blob/main/LICENSE).
8524

86-
To learn React, check out the [React documentation](https://reactjs.org/).
25+
# Contact
26+
For any queries, please [open an issue](https://github.com/data-exp-lab/deepgit/issues) on GitHub

public/deepgit_logo.png

50.4 KB
Loading

public/dxl_logo.png

7.81 KB
Loading

public/favicon-16x16.png

-802 Bytes
Binary file not shown.

public/favicon-32x32.png

-1.31 KB
Binary file not shown.

0 commit comments

Comments
 (0)