52 lines
856 B
Markdown
52 lines
856 B
Markdown
# Getting Started
|
|
|
|
## Cloning the Basic Book Builder
|
|
|
|
|
|
> [!cli] Clone the repository
|
|
> ```
|
|
> git clone https://github.com/jehaverlack/basic-book-builder.git
|
|
> ```
|
|
|
|
|
|
> [!cli] Navigate to the repo directory
|
|
> ```
|
|
> cd basic-book-builder
|
|
> ```
|
|
|
|
## Setting Up Build Environment
|
|
|
|
|
|
> [!caution] ~Debian Linux
|
|
> This script only support Debian based Linux system (Debian, Ubunutu, Zorin, etc)
|
|
> This script has not been widely tested across platforms
|
|
|
|
|
|
|
|
> [!cli] Setup Build Environment
|
|
> ```
|
|
> ./scripts/setup-linux-deb.sh
|
|
> ```
|
|
|
|
For more information on setting up the build environment for your system see Appendix A.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Testing
|
|
|
|
|
|
If you can build all format for the **Basic Book Build** then you have a working build environment.
|
|
|
|
> [!cli] Testing Build Environment
|
|
> ```
|
|
> make all
|
|
> ```
|
|
|
|
|
|
## Creating a New Project
|
|
|
|
|
|
### Zotero Configuration (Optional) |