Skip to content

Commit

Permalink
Get rid of more gitbook junk
Browse files Browse the repository at this point in the history
god
  • Loading branch information
Difegue committed Nov 23, 2021
1 parent 0be9b50 commit 65ea864
Show file tree
Hide file tree
Showing 27 changed files with 23 additions and 12 deletions.
Binary file removed .gitbook/assets/archive_thumb.png
Binary file not shown.
Binary file removed .gitbook/assets/cfg_plugin.png
Binary file not shown.
Binary file removed .gitbook/assets/image (1).png
Binary file not shown.
Binary file removed .gitbook/assets/image (2).png
Binary file not shown.
Binary file removed .gitbook/assets/image (3).png
Binary file not shown.
Binary file removed .gitbook/assets/image (4).png
Binary file not shown.
Binary file removed .gitbook/assets/image (5).png
Binary file not shown.
Binary file removed .gitbook/assets/image.png
Binary file not shown.
Binary file removed .gitbook/assets/index (2).png
Binary file not shown.
Binary file removed .gitbook/assets/karen-dark (2).jpg
Binary file not shown.
Binary file removed .gitbook/assets/karen-install.png
Binary file not shown.
Binary file removed .gitbook/assets/karen-light (2).jpg
Binary file not shown.
Binary file removed .gitbook/assets/karen-uninstall.png
Binary file not shown.
Binary file removed .gitbook/assets/login (1).png
Binary file not shown.
Binary file removed .gitbook/assets/login.png
Binary file not shown.
Binary file removed .gitbook/assets/reader (1).png
Binary file not shown.
Binary file removed .gitbook/assets/reader (2).png
Binary file not shown.
Binary file removed .gitbook/assets/reader.jpg
Binary file not shown.
Binary file removed .gitbook/assets/reader.png
Binary file not shown.
Binary file removed .gitbook/assets/themes (1).png
Binary file not shown.
Binary file removed .gitbook/assets/themes.png
Binary file not shown.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ npm-debug.log
dump.rdb
package-lock.json
.vstags
.gitbook
*qemu-*-static*
Dockerfile.*
.DS_Store
Expand Down
4 changes: 2 additions & 2 deletions tools/Documentation/advanced-usage/external-readers.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Here are some existing clients:
### [Ichaival (Android)](https://github.com/Utazukin/Ichaival)

[Download it here.](https://github.com/Utazukin/Ichaival)\
![ichaival](../.screenshots/ichaival.png)
![ichaival](<../.screenshots/ichaival.png>)

**Features:**

Expand All @@ -29,7 +29,7 @@ Here are some existing clients:
### [LRReader (Windows 10)](https://github.com/Guerra24/LRReader)

[Download it here.](https://github.com/Guerra24/LRReader)\
![lrreader](https://s3.guerra24.net/projects/lrr/screenshots/01.png)
![lrreader](<https://s3.guerra24.net/projects/lrr/screenshots/01.png>)

**Features:**

Expand Down
8 changes: 5 additions & 3 deletions tools/Documentation/basic-operations/archives.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
## Using the Archive Index

The main page will show all the Archives loaded into the application, sorted by name.
![Archive Index in Thumbnail mode](https://raw.githubusercontent.com/Difegue/LANraragi/dev/tools/\_screenshots/archive\_thumb.png)

You can customize display options to show the index in compact mode, as well as to select which namespace to use in the two extra columns.
![Archive Index in Thumbnail mode](<https://raw.githubusercontent.com/Difegue/LANraragi/dev/tools/\_screenshots/archive\_thumb.png>)

You can customize display options to show the index in compact mode, as well as to select which namespace to use in the two extra columns.

![Customized compact mode to sort by ratings](../.screenshots/ratings.png)

The topmost **carousel** view will show random archives from your current search in both thumbnail and compact modes -- It can also be configured to show New or Untagged archives instead.
![Index page of a regular LRR install in compact mode](https://raw.githubusercontent.com/Difegue/LANraragi/dev/tools/\_screenshots/archive\_list.png)
![Index page of a regular LRR install in compact mode](<https://raw.githubusercontent.com/Difegue/LANraragi/dev/tools/\_screenshots/archive\_list.png>)

{% hint style="info" %}
Don't forget you can **right-click** archives to show a context menu, allowing you to edit/download/delete them, or to add them to a category.
Expand Down
18 changes: 13 additions & 5 deletions tools/Documentation/extending-lanraragi/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ I recommend trying to only use exported functions in your code, and consider the

```
root/
|- .devcontainer <- VSCode setup files for Codespaces
|- .github <- Github-specific files
| |- action-run-tests <- Run the LRR Test Suite
| |- ISSUE_TEMPLATE <- Template for bug reports
Expand All @@ -62,20 +63,26 @@ root/
| |- Shinobu.pm <- Background Worker (see below)
| +- LANraragi
| |- Controller <- One Controller per page
| +- *.pm <- Index, Config, Reader, Api, etc.
| | |- Api <- API implementation
| | | +- ...
| +- *.pm <- Index, Config, Reader, etc.
| |- Model <- Application code that doesn't rely on Mojolicious
| |- Api.pm <- Api business implementation
| |- Archive.pm <- Serve files from archives and OPDS catalog
| |- Backup.pm <- Encodes/Decodes Backup JSONs
| |- Category.pm <- Save/Read Category data
| |- Config.pm <- Communicates with the Redis DB to store/retrieve Configuration
| |- Plugins.pm <- Executes Plugins on archives
| |- Reader.pm <- Archive Extraction
| |- Search.pm <- Search Engine
| +- Stats.pm <- Tag Cloud and Statistics
| |- Stats.pm <- Tag Cloud and Statistics
| +- Upload.pm <- Handle incoming files (Download System)
| +- Plugin <- LRR Plugins are stored here
| |- Login
| |- Metadata
| +- Scripts
| +- Utils <- Generic Functions
| |- *.pm
| +- Minion.pm <- Minion jobs are implemented here
|
|- log <- Application Logs end up here
|
Expand Down Expand Up @@ -104,6 +111,7 @@ root/
| +- *.html.tt2
|
|- tools <- Contains scripts for building and installing LRR.
| |- _screenshots <- Screenshots
| |- Documentation <- What you're reading right now
| |- build <- Build tools and scrpits
| |- windows <- Windows build script and submodule link to the Karen WPF Bootstrapper
Expand All @@ -112,11 +120,11 @@ root/
| |- vagrant <- Vagrantfile for LRR Vagrant Machine
| |- cpanfile <- Perl dependencies description
| |- install.pl <- LANraragi Installer
| |- lanraragi-systemd.service <- Example SystemD service
| +- logo.png <- Self-explanatory
| +- lanraragi-systemd.service <- Example SystemD service
|
|- lrr.conf <- Mojolicious configuration file
|- .perltidy.rc <- PerlTidy config file to match the coding style
|- .eslintrc.json <- ESLint config file to match the coding style
+- package.json <- NPM file, contains front-end dependency listing and shortcuts
```

Expand Down
2 changes: 1 addition & 1 deletion tools/Documentation/installing-lanraragi/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This method works on **64-bit** editions of Windows 10 only.
Since LRR 0.8.0, you need Windows 10 version _1903_ at least. 0.7.9 will work with version _1809_ if you're on an LTSC channel.
{% endhint %}

![win10](<../.screenshots/karen-dark.jpg>)
![win10](../.screenshots/karen.jpg)

I provide a dedicated installer for Windows machines as of 0.6.0, complete with a GUI and autostart.

Expand Down
2 changes: 1 addition & 1 deletion tools/Documentation/installing-lanraragi/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ If the installer fails, it's likely because it can't enable the Windows Subsyste

If WSL is installed properly but the tray GUI reports LANraragi as not being installed, try using the `wslconfig.exe /l` command and make sure the "lanraragi" distribution is present.

![](../.screenshots/karen-distro).png)
![](../.screenshots/karen-distro.png)

The tray GUI will show the error message it encountered instead of the LRR Version number if it fails to detect the distro - This might help you troubleshoot further.

Expand Down

0 comments on commit 65ea864

Please sign in to comment.