Skip to content

Commit ddf3e0e

Browse files
author
Steve Salas
committed
Updated for Code Pulse v2.0.0
1 parent f8f83f3 commit ddf3e0e

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

readme.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,34 @@
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GitHub release](https://img.shields.io/github/release/codedx/codepulse.svg)](https://github.com/codedx/codepulse/releases) [![Build status](https://ci.appveyor.com/api/projects/status/ifckp12pjgi96jxs?svg=true)](https://ci.appveyor.com/project/CodeDx/codepulse) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1760/badge)](https://bestpractices.coreinfrastructure.org/projects/1760) [![Github All Releases](https://img.shields.io/github/downloads/codedx/codepulse/total.svg)](https://github.com/codedx/codepulse) [![OWASP Labs](https://img.shields.io/badge/owasp-labs%20project-f7b73c.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Labs_Projects)
44

5-
Code Pulse is a code coverage tool that works on running programs in real time. It uses the [bytefrog](https://github.com/codedx/bytefrog) tracing framework to monitor your Java applications, and displays its findings on a web-based UI.
5+
Code Pulse is a real-time code coverage tool. It works by monitoring Java or .NET Framework applications while they run, keeps track of coverage data, and shows you what's being called and when. Code Pulse currently supports Java programs up to Java 9, and .NET Framework programs for CLR versions 2 & 4.
66

77
## Layout
88

9+
**agent/** Contains the Java tracer source.
10+
11+
**bytefrog/** Contains the [bytefrog](https://github.com/codedx/bytefrog) source upon which the Java tracer depends.
12+
913
**codepulse/** Contains the web app source.
1014

11-
**distrib/** Contains files that are used to package up the entirity of Code Pulse into a native app, using [node-webkit](https://github.com/rogerwang/node-webkit) in place of a browser, and [jetty](http://www.eclipse.org/jetty/) to run the server. All third party dependencies are downloaded automatically within SBT at package time.
15+
**distrib/** Contains files that are used to package up the entirety of Code Pulse into a native app, using [node-webkit](https://github.com/rogerwang/node-webkit) in place of a browser, and [jetty](http://www.eclipse.org/jetty/) to run the server. All third party dependencies are downloaded automatically within SBT at package time.
16+
17+
**dotnet-symbol-service/** Contains the [.NET Symbol Service](https://github.com/codedx/dotnet-symbol-service) source upon which the .NET tracer depends.
18+
19+
**dotnet-tracer/** Contains the .NET tracer source that is based on a custom version of [OpenCover](https://github.com/codedx/opencover).
20+
21+
**installers/** Contains the scripts to package the Code Pulse software for macOS, Linux, and Windows.
1222

1323
**project/** Contains the SBT build definition.
1424

1525
## Setup
1626

17-
- Run SBT from this directory. Run `container:start` to start the webserver on [localhost:8080](http://localhost:8080)
18-
- Eclipse Users:
19-
- Within SBT, run `eclipse` to generate Eclipse project files.
20-
- In Eclipse, import the generated projects to your workspace.
27+
1. Install .NET Core 2.
28+
2. Install Visual Studio 2017.
29+
3. Install WiX Toolset v3.11.
30+
4. Change PowerShell Execution Policy so that local, unsigned Code Pulse PowerShell scripts can run.
31+
5. Run .\installers\build.ps1 with desired script parameter values to create packages for macOS, Linux, and Windows.
32+
6. Open the `installers` folder and refer to the Code Pulse [installation instructions](https://github.com/codedx/codepulse/wiki/Installation). Alternatively, run SBT in the root directory and run `container:start` to start the web server on [localhost:8080](http://localhost:8080).
2133

2234
## License
2335

0 commit comments

Comments
 (0)