Skip to content

Commit

Permalink
Migrate "Install" and "Features" page from Bitbucket
Browse files Browse the repository at this point in the history
Issue: #175
  • Loading branch information
mlopatkin committed Dec 29, 2023
1 parent e529ae6 commit c21b876
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 8 deletions.
1 change: 0 additions & 1 deletion .github/workflows/publish-wiki.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ jobs:
run: |
hugo \
--gc \
--minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
Expand Down
9 changes: 5 additions & 4 deletions docs/site/content/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

https://github.com/mlopatkin/andlogview

Android log viewer is the tool to simplify analysis of the Android logs.
Android log viewer is the tool to simplify analysis of the Android logs, both
live from a device or an emulator, or log and dumpstate files.

![Application window](https://bitbucket.org/mlopatkin/android-log-viewer/wiki/multiple_filters.png)
![Application window](andlogview.png)

![](/adb_setup_prompt.png)

## Features
<!--## Features
- Display logs from a device or an emulator
- Display saved logs and dumpstate files
Expand Down Expand Up @@ -95,3 +95,4 @@ There is a mailing list [android-log-viewer at Google Groups](https://groups.goo
for release announcements and discussions.
Please report bugs to https://github.com/mlopatkin/andlogview/issues
-->
5 changes: 3 additions & 2 deletions docs/site/content/adb_mode/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Working with a device or an emulator
weight: 30
---
Logviewer can display logs directly from an emulator or a device if you have
the Android SDK installed. Simply run a launching script and the Logviewer
AndLogView can display logs directly from an emulator or a device if you have
the Android SDK installed. Simply run a launching script and the AndLogView
will try to connect to the first available device in the "adb devices" list.
If there is no available devices the tool will be waiting for a device to
connect.
Expand Down
Binary file added docs/site/content/andlogview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/site/content/features/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Features
weight: 10
---

* [Display logs from a device or an emulator](/adb_mode)
* Display saved logs and dumpstate files
* Search in the logs using regex if needed
* Filter log lines by tag, PID, log priority, message content
* Filtered lines can be hidden, highlighted or shown in a separate window
* Bookmarks
* Display any avaliable buffers: main, system, events, radio
* Save filtered lines
* Display process list
33 changes: 33 additions & 0 deletions docs/site/content/install/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Installation
weight: 20
---

## Requirements
* Windows, Linux, or MacOS X
* JRE or JDK 8+
* Android SDK (optional, to work with a device or an emulator)

The Java executable (`javaw.exe` on Windows and `java` on Linux/MacOS X) is
expected to be on `PATH`. Alternatively, the `JAVA_HOME` environment variable
should point to the JRE/JDK.

## Installing

Download the [latest release archive](https://github.com/mlopatkin/andlogview/releases/latest) from the GitHub, and unpack it into the location of your
choice.

To run the logview, use the OS-specific script:
* `bin/logview.bat` (Windows)
* `bin/logview` (Linux/MacOS X)

<!--
TODO(mlopatkin): https://github.com/mlopatkin/andlogview/issues/339
If adb.exe/adb aren't on the `PATH` you should manually set its location at the
first launch. You will be prompted about it:
![ADB setup prompt](adb_setup_prompt.png)
Click "Yes" to open [[AdbMode | ADB setup dialog]]. However it is necessary
for working with device/emulator only.
-->
2 changes: 1 addition & 1 deletion docs/site/content/license/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: License
weight: 100
weight: 1000
---
```
Apache License
Expand Down
4 changes: 4 additions & 0 deletions docs/site/data/menu/more.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ more:
ref: "https://github.com/mlopatkin/andlogview/releases"
external: true
icon: "gdoc_download"
- name: Mailing list
ref: "https://groups.google.com/g/android-log-viewer"
external: true
icon: "gdoc_email"
2 changes: 2 additions & 0 deletions docs/site/i18n/en.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
nav_navigation: Contents

0 comments on commit c21b876

Please sign in to comment.