Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hernanmd/cflow-ui

Friendly UI Front-End to cflow in Pharo
https://github.com/hernanmd/cflow-ui

c callgraph cflow dependency-graph pharo static-analysis

Last synced: 2 months ago
JSON representation

Friendly UI Front-End to cflow in Pharo

Host: GitHub
URL: https://github.com/hernanmd/cflow-ui
Owner: hernanmd
Created: 2023-07-19T13:54:15.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-06-07T20:23:59.000Z (7 months ago)
Last Synced: 2024-09-26T21:24:14.990Z (3 months ago)
Topics: c, callgraph, cflow, dependency-graph, pharo, static-analysis
Language: Smalltalk
Homepage:
Size: 37.1 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

[![license-badge](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)

# Table of Contents

- [Description](#description)
- [Installation](#installation)
- [Baseline String](#baseline-string)
- [Usage](#usage)
- [Contribute](#contribute)
- [Version management](#version-management)
- [License](#license)

# Description

A small UI front-end to view C graphs produced by cflow and GraphViz from Pharo >= 12.

# Installation

```bash
brew install cflow
pip install pycflow2dot
```

From Pharo:

```smalltalk
Metacello new
baseline: 'CFlowUI';
repository: 'github://hernanmd/cflow-ui/src';
load.
```

## Baseline String

If you want to add the CFlowUI to your Metacello Baselines or Configurations, copy and paste the following expression:
```smalltalk
" ... "
spec
baseline: 'CFlowUI'
with: [ spec repository: 'github://hernanmd/cflow-ui/src' ];
" ... "
```

# Usage

Go to the menu Library and select the CFlowUI option or evaluate:

```smalltalk
CFlowUISpApplication new run
```

Screenshot 2023-09-19 at 22 59 56

# Contribute

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.
If you have any suggestions for how this package could be improved, please get in touch or suggest an improvement using the GitHub issues page.
If you'd like to make some changes yourself, see the following:

- Fork this repository to your own GitHub account and then clone it to your local device
- Do some modifications
- Test.
- Add to add yourself as author below.
- Finally, submit a pull request with your changes!
- This project follows the [all-contributors specification](https://github.com/kentcdodds/all-contributors). Contributions of any kind are welcome!

## Version management

This project use semantic versioning to define the releases. This means that each stable release of the project will be assigned a version number of the form `vX.Y.Z`.

- **X** defines the major version number
- **Y** defines the minor version number
- **Z** defines the patch version number

When a release contains only bug fixes, the patch number increases. When the release contains new features that are backward compatible, the minor version increases. When the release contains breaking changes, the major version increases.

Thus, it should be safe to depend on a fixed major version and moving minor version of this project.

# License

This software is licensed under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# Authors

Hernán Morales Durand