Prepare for v0.4

PackageInfo.g

@@ -10,8 +10,8 @@ SetPackageInfo( rec(
 
 PackageName := "debugger",
 Subtitle := "Debugging support for GAP",
-Version := "0.3",
-Date := "08/06/2018", # dd/mm/yyyy format
+Version := "0.4",
+Date := "13/02/2021", # dd/mm/yyyy format
 License := "MPL-2.0",
 
 Persons := [

README.md

@@ -1,3 +1,19 @@
 The GAP 4 package `debugger'
 ==============================
 
+This package provides some common features from debuggers.
+
+At present, there are two main features:
+
+* Breakpoints
+ - The function AddBreakpoint(filename, line) will force GAP to break
+   when is reaches lines 'line' in file 'filename.
+
+* Controlling when to enter the break loop.
+ - Once in the break loop, function BreakNextLine will make GAP break
+   on the next line. Users can also break on:
+     - BreakNextEnterFunction, BreakEveryEnterFunction
+     - BreakNextLeaveFunction, BreakEveryLeaveFunction
+
+* Pretty print the state of variables
+ - ShowLocals prints the variables of the current function