ClosedLess/Microsoft-Edge-Updater
ClosedLess/Microsoft-Edge-Updater
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated documentation according to review

Browse Source 
Chnaged documentation based on suggests in the PR review by Robert
Morrison.
This commit is contained in:
Ethan Smith-Coss 2021-06-23 11:26:17 +01:00
parent a68ac1cbac
commit f2ca9217ba
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -12,8 +12,7 @@ DISCLAIMER: Currently this program can only update the Beta release of Microsoft
Options: Options:
-nn, --no-notify Prevent notifications from being set after a session. -nn, --no-notify Prevent notifications from being set after a session.
--mode= Set the mode of the program to be ran in. Default mode --mode= Set the mode of the program to be ran in. Default mode occurs without this flag.
occurs without this flag.
* debug - run program in debug mode. * debug - run program in debug mode.
-y, --yes-all Assume yes to all yes/no decisions. -y, --yes-all Assume yes to all yes/no decisions.
-v, --version Print out the version of the script and exit. -v, --version Print out the version of the script and exit.

12
updater.1
View File

@ -94,7 +94,7 @@ coreutils (>=8.32)
.IP \[bu] 2 .IP \[bu] 2
binutils (>=2.35.1) binutils (>=2.35.1)
.IP \[bu] 2 .IP \[bu] 2
procps procps (only Busybox\-based systems)
.SH FILES .SH FILES
.IP \[bu] 2 .IP \[bu] 2
\f[C]source.list\f[R] \[em] \f[C]source.list\f[R] \[em]
@ -120,27 +120,27 @@ information.
This line can be broken into 4 parts This line can be broken into 4 parts
.RS 2 .RS 2
.IP "1." 3 .IP "1." 3
\f[C][dists=amd64]\f[R] \- \f[C][dists=amd64]\f[R] \[em]
.PD 0 .PD 0
.P .P
.PD .PD
This tells the updater which package architecture it should download for This tells the updater which package architecture it should download for
the system. the system.
.IP "2." 3 .IP "2." 3
\f[C]<https URL>\f[R] \- \f[C]<https URL>\f[R] \[em]
.PD 0 .PD 0
.P .P
.PD .PD
The URL which points to the distribution repository on the Microsoft The URL which points to the distribution repository on the Microsoft
Packages server. Packages server.
.IP "3." 3 .IP "3." 3
\f[C]main\f[R] \- \f[C]main\f[R] \[em]
.PD 0 .PD 0
.P .P
.PD .PD
The main branch of the distribution repository. The main branch of the distribution repository.
.IP "4." 3 .IP "4." 3
\f[C]stable\f[R] \- \f[C]stable\f[R] \[em]
.PD 0 .PD 0
.P .P
.PD .PD
@ -237,7 +237,7 @@ Consult the logs to identify which command returned the exit code.
Ethan Smith\-Coss Ethan Smith\-Coss
.SH CONTRIBUTORS .SH CONTRIBUTORS
.IP \[bu] 2 .IP \[bu] 2
Robert Morrison \- Documentation Robert Morrison \[em] Documentation
.SS Contacting .SS Contacting
.PP .PP
All contacts should be done through Issues on Gitea. All contacts should be done through Issues on Gitea.

12
updater.1.md
View File

@ -66,7 +66,7 @@ Kernel version 5.11.21-179 and later.
* tar * tar
* coreutils (>=8.32) * coreutils (>=8.32)
* binutils (>=2.35.1) * binutils (>=2.35.1)
* procps * procps (only Busybox-based systems)
# FILES # FILES
* `source.list` — * `source.list` —
@ -81,15 +81,15 @@ Kernel version 5.11.21-179 and later.
* `[dists]` — * `[dists]` —
Most iconic line and resembles that of an APT entry for package information. Most iconic line and resembles that of an APT entry for package information.
This line can be broken into 4 parts This line can be broken into 4 parts
1. `[dists=amd64]` - 1. `[dists=amd64]` —
This tells the updater which package architecture it This tells the updater which package architecture it
should download for the system. should download for the system.
2. `<https URL>` - 2. `<https URL>` —
The URL which points to the distribution repository The URL which points to the distribution repository
on the Microsoft Packages server. on the Microsoft Packages server.
3. `main` - 3. `main` —
The main branch of the distribution repository. The main branch of the distribution repository.
4. `stable` - 4. `stable` —
The type of release that should be installed to the system. The type of release that should be installed to the system.
* `[pool]` — * `[pool]` —
The prefix URL to the repository end-point that stores the latest releases. The prefix URL to the repository end-point that stores the latest releases.
@ -136,7 +136,7 @@ Kernel version 5.11.21-179 and later.
* Ethan Smith-Coss * Ethan Smith-Coss
# CONTRIBUTORS # CONTRIBUTORS
* Robert Morrison - Documentation * Robert Morrison — Documentation
## Contacting ## Contacting
All contacts should be done through Issues on Gitea. All contacts should be done through Issues on Gitea.