From 40880b66a90ab3f595c4743ec3d9f96b4f9a7c02 Mon Sep 17 00:00:00 2001
From: Florian Jochens <fj@andaco.de>
Date: Sun, 16 Jan 2022 15:13:34 +0100
Subject: [PATCH] added README
---
assets/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 assets/README.md
diff --git a/assets/README.md b/assets/README.md
new file mode 100644
index 0000000..418fdbe
--- /dev/null
+++ b/assets/README.md
@@ -0,0 +1,46 @@
+# Projekt CiS-Projekt 2021/22
+
+Citation network made with **d3.js**
+
+## Usage
+### Input
+Json file **json\_text.json** in directory
+```json
+{
+ "nodes": [
+ {
+ "name": <title: string>,
+ "author": [<author1: string>, <author2: string>, ...],
+ "year": <date: tring>,
+ "journal": <journal: string>,
+ "doi": <doi: string>,
+ "group": <"input"/"height"/"depth">,
+ "citations": <citation: int>
+ }, ...
+ ],
+ "links": [
+ {
+ "source": <doi: string>,
+ "target": <doi: string>
+ }, ...
+ ]
+}
+```
+
+### Display the Citation Network
+Starting a python web server:
+```sh
+ cd <path to file> &&python3 -m http.server <port>
+```
+Access to the server:
+[http://0.0.0.0/:\<port\>](http://0.0.0.0/:<port>)
+
+## Files in Directory
+- **index.html**: webpage
+- **cn.js**: javascript code for force-directed graph, text elements and legend
+- **json_text.json**: example data
+
+
+## Authors
+- Katja Ehlers
+- Merle Stahl
\ No newline at end of file
--
GitLab