Skip to content

Commit 6baeeac

Browse files
committed
Updated installer script and README
1 parent 46f179a commit 6baeeac

File tree

3 files changed

+46
-8
lines changed

3 files changed

+46
-8
lines changed

NSIS/SEOMacroscope-Installer.nsi

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ Section uninstall
9090
### BEGIN: Program Files
9191

9292
Delete "$INSTDIR\LICENSE"
93+
Delete "$INSTDIR\README.md"
9394

9495
Delete "$INSTDIR\PdfSharp.Charting.resources.dll"
9596
Delete "$INSTDIR\PdfSharp.resources.dll"

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,57 @@
1-
# SEO Macroscope
1+
# SEO MACROSCOPE
22

33
![SEO Macroscope application window](screenshots/application-screen-001.png "SEO Macroscope application window")
44

5-
**This project is still very much a work-in-progress, expect lots of bugs and missing features.**
5+
**This project is still very much under development, expect bugs and unimplemented features.**
66

7-
## Synopsis
7+
## SYNOPSIS
88

9-
SEO Macroscope is a website link checking tool, with some technical SEO functionality.
9+
**SEO Macroscope** for Microsoft Windows is a website link checking and scanning tool, with some technical SEO functionality.
1010

11-
## Installation
11+
## INSTALLATION
1212

13-
There is no installer for SEO Macroscope ready quite yet. The C# solution may be opened and run using SharpDevelop 5 or Visual Studio; it may also compile and run using MonoDevelop.
13+
The most recent installer may be found under the project releases area on GitHub at:
1414

15-
As soon as the project has reached a suitably stable point, I shall release an installer.
15+
> [https://github.com/nazuke/SEOMacroscope/releases](https://github.com/nazuke/SEOMacroscope/releases)
16+
17+
The C# solution itself may be opened and run using SharpDevelop 5 or Visual Studio; it may also compile and run using MonoDevelop.
1618

1719
Open the solution in SharpDevelop or Visual Studio, ensure that the references are satisfied, set build to **Debug**, compile and run.
1820

19-
## Usage
21+
## USAGE
2022

2123
Enter the URL of the website to scan into the **Start URL** field, and then click the **Start** button.
2224

2325
Depending on the size and responsiveness of your website, it may take a while to complete the scan.
26+
27+
28+
## FEATURES
29+
30+
There are still going to be many bugs in this version, and many features and functions remain to be implemented.
31+
32+
However, this beta version is functional enough to be used for many link checking tasks right now.
33+
34+
### Basic functionality includes:
35+
36+
* Scanning all links on one or more websites.
37+
* Reporting broken, redirected, and other types of issues.
38+
* Reporting metadata about each found URL.
39+
* Generating an HrefLang Matrix, for multilingual websites.
40+
* Isolating scans to URL subsets.
41+
* Extraction and report of telephone number and email links.
42+
43+
### SEO functionality includes:
44+
45+
* Set and report acceptable word, character, and pixel lengths for titles.
46+
* Set and report acceptable word, character lengths for descriptions.
47+
* Report on titles, descriptions, keywords, and headings.
48+
* Optionally generate keyword occurrences across pages and the entire site.
49+
* Scan and extract metadata for PDFs.
50+
51+
### Reports may be exported to Excel format. Currently, these include:
52+
53+
* A scan overview.
54+
* An HrefLang Matrix of multilingual sites.
55+
* Page contents, including titles, descriptions, keywords, and headings.
56+
57+
More functionality will be added in the future.

SEOMacroscope.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@
9292
<Reference Include="System.Xml" />
9393
</ItemGroup>
9494
<ItemGroup>
95+
<None Include="README.md">
96+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
97+
</None>
9598
<None Include="version.nsh">
9699
<DependentUpon>version.tt</DependentUpon>
97100
<AutoGen>True</AutoGen>

0 commit comments

Comments
 (0)