Skip to content

Commit

Permalink
Updating the main readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
kiddinn authored Nov 21, 2018
1 parent d84e758 commit 1f2def5
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PlasoScaffolder
PlasoScaffolder is a tool that provides scaffolders for various open source projects. It can be used to bootstrap plugin or parser generation for tools like plaso, to make development work easier.
# L2tScaffolder
L2tScaffolder is a tool that provides scaffolders for various open source projects. It can be used to bootstrap plugin or parser generation for tools like plaso, to make development work easier.

### Project status
[Travis-CI](https://travis-ci.org/) | [Codecov](https://codecov.io/)
Expand All @@ -10,30 +10,29 @@ PlasoScaffolder is a tool that provides scaffolders for various open source proj
In essence the tool can be simply run as:

```
$ l2t_scaffolder
$ l2t_scaffolder.py
```

The tool will then guide you towards creating all the necessary files to generate a parser, plugin or a module for the given tool. Another way to run the tool is:

```
$ l2t_scaffolder <PROJECT>
$ l2t_scaffolder.py <PROJECT>
```

eg:

```
$ l2t_scaffolder plaso
$ l2t_scaffolder.py plaso
```

This will run the scaffolder tool to generate a plugin or a parser for plaso.

Also see:

+ https://claudiasaxer.github.io/PlasoScaffolder <br>
+ http://l2tscaffolder.readthedocs.io

### Requirements
Python 3.6, Python 2 is not supported.
Python 3.6+, Python 2 is not supported.

### Installation
pip install l2tscaffolder
Expand All @@ -43,5 +42,5 @@ The original PlasoScaffolder was written by [Claudia Saxer](https://github.com/C
as part of her BSc and integrated into the log2timeline organization for
purpose of maintenance.

The original version of the tool was rewritten to l2t_scaffolder and the tool
The original version of the tool was then rewritten to l2t_scaffolder and the tool
extended to support other projects than plaso SQlite plugin generation.

0 comments on commit 1f2def5

Please sign in to comment.