Skip to content

Commit

Permalink
docs: add docs for example data and print format
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Aug 26, 2022
1 parent b423605 commit 9f6761b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/version-13/exampledata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Using the Example Data to Experiment with Check Run

The Check Run application comes with a `test_setup.py` script that is completely optional to use. If you execute the script, it populates your ERPNext site with demo business data for a fictitious company called Chelsea Fruit Co. The data enable you to experiment with and test the Check Run application's functionality before installing the app into your ERPNext site.

It's recommended to install the demo data into its own site to avoid potential interference with the configuration or data in your organization's ERPNext site.

With `bench start` running in the background, run the following command to install the demo data:

```shell
bench execute 'check_run.test_setup.before_test'
```

Refer to the [installation guide](./installationguide.md) for detailed instructions for how to set up a bench, a new site, and installing ERPNext and the Check Run application.
5 changes: 5 additions & 0 deletions docs/version-13/exampleprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Example Print Format: Voucher Check

[TODO]

To take advantage of Check Run's check printing functionality, [there must be a print format set up in ERPNext]. Print formats are as unique as the entities using ERPNext, so this voucher check print format serves as an example template. It can be a starting point from which to customize to suit your organization's needs.

0 comments on commit 9f6761b

Please sign in to comment.