Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vipinpaul authored Sep 12, 2024
1 parent d6855e3 commit 7bd04dd
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="">
<img src="https://github.com/bible-technology/scribe-scripture-editor/blob/development/styles/scribe-logo.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Scribe Scripture Editor (Scribe v2)</h3>

<p align="center">
A Bible translation editor for everyone.
<br />
<a href="https://github.com/BiblioNexus-Foundation/scribe/issues">Report Issue</a>
·
<a href="https://github.com/BiblioNexus-Foundation/scribe/issues">Feature Request</a>
</p>
</p>

<!-- GETTING STARTED -->

## Getting Started

It is relatively easy to set up the application locally for development.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

- [Node.js ^16.15.1](https://nodejs.org/en/)
- [YARN ^1.7.0 <2](https://yarnpkg.com/getting-started)

### Installation

1. Fork and clone this repository
2. Install dependencies and Build the app in development mode with `yarn run build:dev`
3. Start the application(electron) with `yarn start:electron`

0 comments on commit 7bd04dd

Please sign in to comment.