Przeglądaj źródła

Issue #2: updated README.md files

cycle20 2 lat temu
rodzic
commit
758b857e31
2 zmienionych plików z 15 dodań i 1 usunięć
  1. 5 0
      src/apps/tm-viewer/README.md
  2. 10 1
      src/extensions/tmdet/README.md

+ 5 - 0
src/apps/tm-viewer/README.md

@@ -33,6 +33,11 @@ Open `http://localhost:8000/` in web browser.
 $ npm run watch-tm
 ```
 
+# Authors
+
+* Gabor Tusnady (tusnady.gabor at ttk.hu), Protein Bioinformatics Research Group, RCNS.
+* Csongor Gerdan (gerdan.csongor at ttk.hu), Protein Bioinformatics Research Group, RCNS.
+
 # License
 
 Creative Commons Attribution-NonCommercial 4.0 International Public

+ 10 - 1
src/extensions/tmdet/README.md

@@ -26,7 +26,11 @@ For example:
     var pdbId = '1a0s';
 
     tm_molstar.loadWithUNITMPMembraneRepresentation(viewer.plugin, {
+
+        // URL to get mmCIF/PDBx data
         structureUrl: `https://cs.litemol.org/${pdbId}/full`,
+
+        // URL to load PDBTM information according to FunPDBe Data Exchange Format
         regionDescriptorUrl: `http://localhost:8000/tmdet-data/${pdbId}.json`,
     });
 ...
@@ -34,8 +38,13 @@ For example:
 ```
 
 Please see the `index.html` and `index.ts` files of the demo
-application in the `src/apps/tm-viwer` folder for more details.
+application in the `src/apps/tm-viwer` folder and example data
+files in `data/tmdet-example-annotations` folder for more details.
+
+# Authors
 
+* Gabor Tusnady (tusnady.gabor at ttk.hu), Protein Bioinformatics Research Group, RCNS.
+* Csongor Gerdan (gerdan.csongor at ttk.hu), Protein Bioinformatics Research Group, RCNS.
 
 # License