Merge pull request #156 from KnowledgeCaptureAndDiscovery/dev

Fix #134

Author: dgarijo

README.md

@@ -1,4 +1,4 @@
-# SOMEF [![DOI](https://zenodo.org/badge/190487675.svg)](https://zenodo.org/badge/latestdoi/190487675)
+# SOMEF [![DOI](https://zenodo.org/badge/190487675.svg)](https://zenodo.org/badge/latestdoi/190487675) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/KnowledgeCaptureAndDiscovery/somef/HEAD?filepath=notebook%2FSOMEF%20Usage%20Example.ipynb)
 Software Metadata Extraction Framework: A command line interface for automatically extracting relevant information from readme files.
 
 **Authors:** Daniel Garijo, Allen Mao, Haripriya Dharmala, Vedant Diwanji, Jiaying Wang and Aidan Kelley.
@@ -119,6 +119,7 @@ Options:
                                   supplied, the output will be a Knowledge
                                   Graph, in the format given in the --format
                                   option
+    -c, --codemeta_out PATH       Path to an output codemeta file (in JSON-LD)
 
   -f, --graph_format [turtle|json-ld]
                                   If the --graph_out option is given, this is
@@ -157,8 +158,4 @@ pages={3032-3037}
 ```
 
 ## Next features:
-We are improving SOMEF to incorporate the following features:
-- Automated detection of other documentations sources, besides the readme.md file.
-- Automated detection and annotation of Docker files.
-- Automated detection and annotation of notebooks and their metadata.
-- Automated detection of examples associated with a software component.
+To see upcoming features, please have a look at our [open issues](https://github.com/KnowledgeCaptureAndDiscovery/somef/issues) and [milestones](https://github.com/KnowledgeCaptureAndDiscovery/somef/milestones)

docs/index.md

@@ -12,25 +12,33 @@ SOMEF has currently been tested with GitHub repositories, but it can extract met
 ## Features
 Given a readme file (or a GitHub repository) SOMEF will extract the following categories (if present):
 
+- **Name**: Name identifying a software component
+- **Full name**: Full name of the software (not abbreviated)
 - **Description**: A description of what the software does.
 - **Citation**: Preferred citation (usually in `.bib` form) as the authors have stated in their readme file.
 - **Installation instructions**: A set of instructions that indicate how to install a target repository
 - **Invocation**: Execution command(s) needed to run a scientific software component
 - **Usage examples**: Assumptions and considerations recorded by the authors when executing a software component, or examples on how to use it.
-- **Download URL**: URL where to download the target software (typically the installer, package or a tarball to a stable version)
+- **Documentation**:
 - **Requirements**: Pre-requisites and dependencies needed to execute a software component.
-- **Contact**: Contact person responsible for maintaining a software component
 - **Contributors**: Contirbutors to a software component
 - **FAQ**: Frequently asked questions about a software component
 - **Support**: Guidelines and links of where to obtain support for a software component
-- **Name**: Name identifying a software component
 - **License**: License and usage terms of a software component
+- **Contact**: Contact person responsible for maintaining a software component
+- **Download URL**: URL where to download the target software (typically the installer, package or a tarball to a stable version)
+- **DOI**: Digital Object Identifier associated with the software (if any)
+- **DockerFile**: Build file to create a Docker image for the target software
+- **Notebooks**: Jupyter notebooks included in a repository
+- **Owner**: Name of the user or organization in charge of the repository
 - **Keywords**: set of terms used to commonly identify a software component
 - **Source code**: Link to the source code (typically the repository where the readme can be found)
 - **Releases**: Pointer to the available versions of a software component
 - **Changelog**: Description of the changes between versions
+- **Issue tracker**: Link where to open issues for the target repository
+- **Programming languages**: Languages used in the repository
 
-SOMEF uses the [Software  Description Ontology](https://w3id.org/okn/o/sd), which extends [Schema.org](https://schema.org) and [Codemeta](https://codemeta.github.io/terms/) to represent all the categories listed above.
+SOMEF uses the [Software  Description Ontology](https://w3id.org/okn/o/sd), which extends [Schema.org](https://schema.org) and [Codemeta](https://codemeta.github.io/terms/) to represent all the categories listed above. To see different export options please see [the getting started page](https://somef.readthedocs.io/en/latest/usage/).
 
 ## Used Technologies and Standards
 
@@ -49,5 +57,5 @@ The JavaScript Object Notation (JSON) is a syntax for storing and exchanging dat
 ### RDF
 We use the Resource Description Framework (RDF) to serialize our results. We currently provide two different serializations: [JSON-LD](https://www.w3.org/TR/json-ld11/) and [Turtle](https://www.w3.org/TR/turtle/). The main difference between the JSON and RDF serializations is that they are simpler and do not incorporate the confidence of the results.
 
-SOMEF uses the [Software  Description Ontology](https://w3id.org/okn/o/sd), which extends [Schema.org](https://schema.org) and [Codemeta](https://codemeta.github.io/terms/).
+SOMEF uses the [Software  Description Ontology](https://w3id.org/okn/o/sd), which extends [Schema.org](https://schema.org) and [Codemeta](https://codemeta.github.io/terms/). We also support a Codemeta-specific export.