Skip to content

Polish readme #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dazering merged 1 commit into from
Jul 7, 2026
Merged

Polish readme #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions HomeLibProt.CollectionManager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Console application for managing collection

## Requirements
## Build requirements

- .NET SDK 8.0+

Expand Down Expand Up @@ -192,7 +192,7 @@ FlibustaGetDailyUpdateFb2.sh {InpxPath} {LibraryPath}
4. Creating daily archive from `Updates/Fb2` in `LibraryPath` with name `{currentYear}-{currentMonth}-f.fb2-{firstBookNumber}-{lastBookNumber}.zip`
5. Downloading sql dumps from Flibusta to `flibusta_sql_dumps` directory
6. Importing sql dumps to sqlite database
7. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx"`
7. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx`
8. Copy generated inpx to `InpxPath`
9. Run `PostUpdate.(ps1|sh)` script

Expand All @@ -219,7 +219,7 @@ FlibustaGetDailyUpdateFb2AndUsr.sh {InpxPath} {LibraryPath}
7. Creating daily archive from `Updates/Binary` in `LibraryPath` with name `{currentYear}-{currentMonth}-f.usr-{firstBookNumber}-{lastBookNumber}.zip`
8. Downloading sql dumps from Flibusta to `flibusta_sql_dumps` directory
9. Importing sql dumps to sqlite database
10. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_all_local.inpx"`
10. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_all_local.inpx`
11. Copy generated inpx to `InpxPath`
12. Run `PostUpdate.(ps1|sh)` script

Expand All @@ -240,7 +240,7 @@ FlibustaGetMonthlyUpdateFb2.sh {InpxPath} {LibraryPath}
1. Creating monthly archive from `LibraryPath` in `LibraryPath` with name `f.fb2-{firstBookNumber}-{lastBookNumber}.zip` from archives coppesponding filter `{currentYear}-{currentMonth}-f.fb2-*.zip`
2. Downloading sql dumps from Flibusta to `flibusta_sql_dumps` directory
3. Importing sql dumps to sqlite database
4. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx"`
4. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx`
5. Copy generated inpx to `InpxPath`
6. Run `PostUpdate.(ps1|sh)` script

Expand All @@ -262,7 +262,7 @@ FlibustaGetMonthlyUpdateFb2AndUsr.sh {InpxPath} {LibraryPath}
2. Creating monthly archive from `LibraryPath` in `LibraryPath` with name `f.fb2-{firstBookNumber}-{lastBookNumber}.zip` from archives coppesponding filter `{currentYear}-{currentMonth}-f.usr-*.zip`
3. Downloading sql dumps from Flibusta to `flibusta_sql_dumps` directory
4. Importing sql dumps to sqlite database
5. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx"`
5. Generating inpx from sqlite database to `flibusta_sql_dumps/flibusta_fb2_local.inpx`
6. Copy generated inpx to `InpxPath`
7. Run `PostUpdate.(ps1|sh)` script

Expand All @@ -283,7 +283,7 @@ For windows:
| -- PostUpdate.ps1
```

And Linix:
And Linux:

```
| -- HomeLibProt.CollectionManager
Expand Down Expand Up @@ -335,7 +335,7 @@ systemctl list-timers
3. Run command

```
HomeLibProt.CollectionManager.exe mergebooks -i {pathToUpdates} -o {pathToLibrary} -s 10000 -p "{currentYear}-{currentMonth}-f.fb2-" -f "*.zip"
HomeLibProt.CollectionManager.exe mergebooks -i {pathToLibrary}/Update/Fb2 -o {pathToLibrary} -s 10000 -p "{currentYear}-{currentMonth}-f.fb2-" -f "*.zip"
```

Example
Expand All @@ -347,7 +347,7 @@ HomeLibProt.CollectionManager.exe mergebooks -i C:\BookDemo\Books\Update\Fb2 -o
4. Run command

```
HomeLibProt.CollectionManager.exe mergebooks -i {pathToUpdates} -o {pathToLibrary} -s 10000 -p "{currentYear}-{currentMonth}-f.usr-" -f "*.zip"
HomeLibProt.CollectionManager.exe mergebooks -i {pathToLibrary}/Update/Binary -o {pathToLibrary} -s 10000 -p "{currentYear}-{currentMonth}-f.usr-" -f "*.zip"
```

Example
Expand All @@ -360,9 +360,9 @@ HomeLibProt.CollectionManager.exe mergebooks -i C:\BookDemo\Books\Update\Binary

```
| -- logs
| -- | errors-{yyyyMMdd}.txt
| -- | fatal-{yyyyMMdd}.txt
| -- | information-{yyyyMMdd}.txt
| | errors-{yyyyMMdd}.txt
| | fatal-{yyyyMMdd}.txt
| | information-{yyyyMMdd}.txt
| -- Scripts
| | -- ....
| -- HomeLibProt.CollectionManager.exe
Expand Down
12 changes: 6 additions & 6 deletions HomeLibProt.CommandLineImporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Console application for importing inpx to sqlite database

## Requirements
## Build requirements

- .NET SDK 8.0+

## Build source from source files
## Build from source files

```
dotnet build .\HomeLibProt.CommandLineImporter\HomeLibProt.CommandLineImporter.fsproj
```

## Publish from source from source files
## Publish from source files

Linux

Expand Down Expand Up @@ -90,9 +90,9 @@ Tested with inpx contains 1M lines, 100 inp files, 1M authors, genres, series an

```
| -- logs
| -- | errors-{yyyyMMdd}.txt
| -- | fatal-{yyyyMMdd}.txt
| -- | information-{yyyyMMdd}.txt
| | errors-{yyyyMMdd}.txt
| | fatal-{yyyyMMdd}.txt
| | information-{yyyyMMdd}.txt
| -- Scripts
| | -- ....
| -- HomeLibProt.CommandLineImporter.exe
Expand Down
Loading