Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ The workspace structure is as follows.
```
.
├── packages
│ ├── component
│ ├── core
│ ├── pdf
│ ├── barcode
│ ├── component
│ ├── core
│ ├── pdf
```

- packages/core: Super Leopard core library
- packages/component: Super Leopard GUI library
- packages/pdf: PDF output library
- packages/barcode: Barcode output library

### core library

Expand All @@ -46,6 +48,11 @@ This library basically prints reports (templates) defined in JSON by providing d
The core library defines the format and basic behavior of the underlying reports.
If you need a report that outputs something other than web or PDF, you can create it using the core library.

## barcode library

Provides a library for outputting barcodes.
It is used from the component and pdf libraries.

### pdf library

This provides a library for outputting PDF.
Expand All @@ -59,10 +66,4 @@ You can edit templates on a web screen.
The component is implemented using React and MUI.
We also use jotai for state management.

![report editor](docs/en/images/report_editor.png)


License
-------

MIT
![report editor](packages/component/docs/images/report_editor.png)
7 changes: 7 additions & 0 deletions docs/ja/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ workspace の構成は、次のようになります。
```
.
├── packages
│ ├── barcode
│ ├── component
│ ├── core
│ ├── pdf
Expand All @@ -32,6 +33,7 @@ workspace の構成は、次のようになります。
- packages/core: Super Leopard のコアライブラリ
- packages/component: Super Leopard の GUI を提供するライブラリ
- packages/pdf: PDF を出力するライブラリ
- packages/barcode: バーコードを出力するライブラリ

### core ライブラリ

Expand All @@ -44,6 +46,11 @@ component ライブラリで定義されている GUI を使って生成でき
その基礎となるレポートの書式や基本的な動作を定義しているのがこの core ライブラリです。
Web や PDF 以外に出力する帳票が必要になった場合は、core ライブラリを使用して作成することができます。

### barcode ライブラリ

バーコードを出力するためのライブラリを提供します。
component と pdf ライブラリから使用されます。

### pdf ライブラリ

PDF を出力するためのライブラリを提供します。
Expand Down
Loading