From 1f2def57fad2c1c9d2a57dac6dd24d1938d0c907 Mon Sep 17 00:00:00 2001 From: Kristinn Date: Wed, 21 Nov 2018 16:54:32 +0000 Subject: [PATCH] Updating the main readme file --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a84467a..92b0bc7 100644 --- a/README.md +++ b/README.md @@ -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/) @@ -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 +$ l2t_scaffolder.py ``` 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
+ 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 @@ -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.