Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 3.53 KB

README.md

File metadata and controls

95 lines (63 loc) · 3.53 KB

image

license issues

This plugin categorizes software files by extension, to illustrate the contents of a software project

For the sake of this demonstration, we have analyzed OBS Studio

The files generated can be integrated in Dx Platform

Installation

  • Start by downloading a release version from this repository. Click on Releases and download the .rar file
  • Extract the contents of the .rar file in the desired location

[Optional] Running this program as a Docker image

  • STEP 1: you must have Docker installed. You can download it from here

  • STEP 2: you need to create a file with the name config.properties with the follow content :

    projectName=OBS_P
projectPath=/sources
os_type=windows

  • STEP 3: is to create an empty .json file with the project name from config and -output.json (e.g. OBS_P-output.json).

  • STEP 4: to run the command, we have to create 3 volumes in docker:

    • one for the output file,
    • one for the config.properties,
    • and one for the path to our project.

  • Windows Command :

docker run -v %cd%/config.properties:/extension-map/config.properties -v %cd%/OBS_P-output.json:/extension-map/OBS_P-output.json -v C:/Users/Ade_3/.dx-platform/projects/OBSP/repository/obs-studio:/sources cryston/extension-map:1.0
  • Linux Command :
docker run -v $PWD/config.properties:/extension-map/config.properties -v $PWD/OBS_P-output.json:/extension-map/OBS_P-output.json -v C:/Users/Ade_3/.dx-platform/projects/OBSP/repository/obs-studio:/sources cryston/extension-map:1.0

Docker Image

Usage

  • After all the files have been extracted, the folder should look like so:

image

  • Modify the project path, project name and os_type entries from config.properties file. For example:
  projectName=obs-studio
  projectPath=C:\\Users\\Roland\\CES_obs
  os_type=windows

  • IMPORTANT

    • DO NOT add spaces before or after the config file entries
    • Specify the absolute project path(starting from the root folder)
    • os_type can be windows or linux (in lowercase)

  • Open a command prompt(or Powershell window) and type in either of the following commands:

    • or double click either one of the files..
  run.bat
  run.sh
  • If everything was configured correctly, the program should start, a file named "projectName-output.json" file should be generated, and the command prompt window should like this:

image

image

The team

  • Deaconu Adrian-Sebastian
  • Tamas Roland

Contributions

If you would like to contribute to this project, you can fork the repository and modify the files, or you can clone the repository.

Credits

We would like to thank Java for making the development of this plugin possible.