https://github.com/gecko655/proofreading-tool

GUIで動作する文書校正ツール GUI tool for textlinting.
https://github.com/gecko655/proofreading-tool

proofreading

Last synced: 12 months ago
JSON representation

GUIで動作する文書校正ツール GUI tool for textlinting.

• Host: GitHub
• URL: https://github.com/gecko655/proofreading-tool
• Owner: gecko655
• License: gpl-3.0
• Created: 2021-04-08T03:06:36.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-25T08:37:04.000Z (over 1 year ago)
• Last Synced: 2024-11-20T01:33:13.683Z (over 1 year ago)
• Topics: proofreading
• Language: JavaScript
• Homepage: https://gecko655.hatenablog.com/entry/proofreading-tool
• Size: 1.96 MB
• Stars: 86
• Watchers: 4
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
proofreading-tool

===

[![Build/release](https://github.com/gecko655/proofreading-tool/actions/workflows/electron-release.yml/badge.svg)](https://github.com/gecko655/proofreading-tool/actions/workflows/electron-release.yml)

![Github All Releases](https://img.shields.io/github/downloads/gecko655/proofreading-tool/total.svg)

(Download count not included for v1.0.4 or earlier versions)

![proofreading-tool-demo](https://user-images.githubusercontent.com/6166778/116985820-f616d580-ad07-11eb-971f-60ec887cff67.gif)

GUIで動作する文書校正ツール

GUI tool for textlinting.

# Usage

https://gecko655.hatenablog.com/entry/proofreading-tool

# Install

https://github.com/gecko655/proofreading-tool/releases

# How to build

## Prepare

```bash

# Fetch dependencies

yarn install

# Build webpack

yarn webpack # or `npm run webpack-prod` or `npm run webpack-watch`

```

## Debug

```bash

yarn  start

```

## Test

```bash

yarn lint # or `npm run lint:fix` (prettier fixes the code format)

```

## Build for production

```bash

yarn webpack-prod

yarn dist:mac # or `npm run dist:win`

```

The build artifacts should be located under the `dist/` folder.

## Release

- Edit package.json to update version number.

- Push tag with the same version number with prefix 'v'.

```bash

git tag vX.Y.Z

git push --tags

```

- [GitHub Action](https://github.com/gecko655/proofreading-tool/actions) creates a [draft release](https://github.com/gecko655/proofreading-tool/releases)

- Release the draft.

# LICENSE

This software is released under [GPLv3 LICENSE](LICENSE).

This software uses [xpdf(pdftotext)](https://www.xpdfreader.com/), which is released under GPLv3 license.

# special thanks

https://github.com/mixigroup