Skip to content

Commit 6de328b

Browse files
Update README.md
1 parent ac539f1 commit 6de328b

File tree

1 file changed

+39
-40
lines changed

1 file changed

+39
-40
lines changed

README.md

Lines changed: 39 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,30 @@
11
[![logo](Docs/Logos/RegexAssitant_Logo.png)](https://github.com/David-Maisonave/RegexAssistant)
22
# RegexAssistant
33
[![All Releases](https://img.shields.io/github/downloads/David-Maisonave/RegexAssistant/total.svg)](https://github.com/David-Maisonave/RegexAssistant/releases/latest)
4-
54
RegexAssistant is an open source Regular Expression (Regex) find and replace tool for Windows.
65
It has an easy to use UI that can build and test regex, and the results are seen real time as expression is typed into the GUI.
76
It has a cheat-sheet token window which list the main regex tokens and common patterns. Items in the token list can be inserted into the Expression (regex) field by double clicking the desired token.
87

98
## Downloads
109
Use the following link to download the latest release binaries: [Download](https://github.com/David-Maisonave/RegexAssistant/releases/latest)
11-
1210
## Features
1311
[![Screenshot1](Docs/ProjectImages/RegexAssistantInAction.png)](https://github.com/David-Maisonave/RegexAssistant)
14-
15-
### Real time results
12+
#### Real time results
1613
The results are displayed in real time to quickly let the user see when an expression is working, and exactly when it stops working.
17-
18-
### Compatibility Option
14+
#### Compatibility Option
1915
The compatibility option allows the user to select the target regex implementation to display results for.
2016
Currently available targets are Boost, Scintilla, POSIX, STD Regex, Perl, and SED.
21-
22-
### Regex Replace
17+
#### Regex Replace
2318
Regex replace is supported when compatibility is switch to boost or STD types. The token list has example regex replacement patterns at the bottom of the list.
2419
These patters can help the user to quickly test there replace expression, and user can easily undo the results by clicking the Undo button.
25-
26-
### Cheat-sheet (Token List)
20+
#### Cheat-sheet (Token List)
2721
A list window displays the regex tokens
2822
The first column displays the token itself. The second column gives a description.
2923
The Third column gives example usage, and the last column displays matches for the examples.
3024

3125
When the user double clicks a token in the first column, the token gets inserted into the expression at the cursor position.
3226

33-
#### Cheat-sheet Common Patterns
27+
##### Cheat-sheet Common Patterns
3428
The token window list many common patterns that the user can use just by double clicking on the desired patterns.
3529
Here's a list of just a few of the many patterns that are listed.
3630
##### Phone pattern
@@ -45,50 +39,55 @@ Here's a list of just a few of the many patterns that are listed.
4539
##### Error reporting pattern
4640
##### GUID pattern
4741

48-
### Convert FileSystem and SQL Wildcards to Regex
49-
#### Convert FileSystem
42+
#### Convert FileSystem and SQL Wildcards to Regex
43+
##### Convert FileSystem
5044
This option is for users who are more familiar with windows file system wildcards (*?).
5145
It allows the user to convert an expression using the file system wildcards into a regex expression, using regex wildcards.
52-
53-
#### Convert SQL
46+
##### Convert SQL
5447
This option is for users who are more familiar with SQL wildcards (%_#*?).
5548
It allows the user to convert an expression using the SQL wildcards into a regex expression, using regex wildcards.
5649

57-
# RegexAssistant Source Code
58-
## Requirements
5950

60-
### Visual Studio 2017
6151

52+
## RegexAssistant Build Instructions
53+
### Summary
54+
RegexAssistant can be built using Visual Studio (2017 or 2019) with the solution file RegexAssistant.sln.
55+
It requires 2 external libaries (Boost and Scintilla). These 2 libraries are **not** included in the repository.
56+
57+
#### Visual Studio Requirement
58+
##### Visual Studio 2017
6259
* *Community*, *Professional* or *Enterprise* Edition
6360
* VC++ 2017 v141 toolset
6461
* Windows XP support for C++
6562
* MFC and ATL support
6663
* Windows 10 SDK
67-
68-
### Visual Studio 2019
69-
64+
##### Visual Studio 2019
7065
* *Community*, *Professional* or *Enterprise* Edition
7166
* MSVC v142 Buildtools
7267
* C++ MFC for v142 Buildtools
7368
* Windows 10 SDK
7469

75-
## Folder Structure
76-
77-
Source base code for the RegexAssistant program is kept in the sub-folder RegexAssistant.
78-
RegexAssistant requires two libraries (Boost and Scintilla). These to libraries are not yet included in the project.
79-
80-
# Roadmap
81-
1. Add logic to allow window to shrink down further
82-
3. Add logic to remember last window size and position (to include monitor)
83-
4. Add split line to allow user to change size ratio of the token window against the sample window.
84-
5. Add button that will replace the target text with clipboard content
85-
6. Add button that will append the target text field with clipboard content
86-
7. Add command line option that will replace target text with clipboard content when the program starts
87-
8. Add command line option to populate the regex input field on program startup
88-
9. Add command line option to perform a regex replace on a file or multiple files matching DOS wildcards
89-
10. Add context menu item to replace (or append) sample with multiple sets of examples designed for each pattern listed in the token list
90-
11. Add Build button which disables real time results
91-
12. Add a build wizard option that will let user go step by step creating an expression.
92-
13. Add logic to perform file find, rename, delete, & move based on the regex patterns
93-
14. Add drag and drop logic for sample window.
70+
#### External libaries (Boost and Scintilla)
71+
1. Download [Boost version 1.77](https://www.boost.org/users/download/) or greater. Extract the boost folder and save it to the same location as the solution (**RegexAssistant.sln**) file. Rename the folder from **boost_1_77_0** to **boost**.
72+
2. Download [Scintilla version 5.1.1](https://www.scintilla.org/scite511.zip) or greater. Extract only the **scintilla** folder, and put it at the same locations as the solution (**RegexAssistant.sln**) file.
73+
74+
The RegexAssistant folder should look like the following:
75+
76+
#### Build Solution
77+
Open the solution using Visual Studio, and press the F7 key to build the solution.
78+
79+
80+
## To-Do
81+
* Add logic to allow window to shrink down further
82+
* Add logic to remember last window size and position (to include monitor)
83+
* Add split line to allow user to change size ratio of the token window against the sample window.
84+
* Add button that will replace the target text with clipboard content
85+
* Add button that will append the target text field with clipboard content
86+
* Add command line option that will replace target text with clipboard content when the program starts
87+
* Add command line option to populate the regex input field on program startup
88+
* Add command line option to perform a regex replace on a file or multiple files matching DOS wildcards
89+
* Add context menu item to replace (or append) sample with multiple sets of examples designed for each pattern listed in the token list
90+
* Add Build button which disables real time results
91+
* Add logic to perform file find, rename, delete, & move based on the regex patterns
92+
* Add drag and drop logic for sample window.
9493

0 commit comments

Comments
 (0)