Skip to content

Commit 62c1769

Browse files
authored
Update README.md
1 parent 61ec8b4 commit 62c1769

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

+37-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1-
# p5.js-getting-started-es
2-
Spanish translation of Getting Started with p5.js
1+
# Introducción a p5.js
2+
Repository for the source material for the Spanish translation of Getting Started with p5.js. The book is now available on [processingfoundation.press](https://processingfoundation.press/). A physical copy of the book can be ordered [here](https://www.amazon.com/Introducci%C3%B3n-p5-js-Spanish-Lauren-McCarthy/dp/0999881302).
3+
4+
## Production
5+
The following contains documentation for setting up the project locally in order to generate PDF builds for upcoming versions and changes.
6+
7+
### Getting Started
8+
First, clone this repository with the following using terminal:
9+
```bash
10+
git clone https://github.com/processing/p5.js-getting-started-es.git
11+
```
12+
As we will be using [magicbook](https://github.com/magicbookproject/magicbook) for this project, make sure to install the `magicbook` package:
13+
```bash
14+
npm install magicbook -g
15+
```
16+
### Fonts
17+
In order to make a proper build, you will need to have the correct typefaces in the `fonts/` folder which are listed in `fonts/font-list.txt`.
18+
19+
### Making a Build
20+
To make a new build, first make sure you are in the project folder.
21+
```bash
22+
cd p5.js-getting-started-es
23+
magicbook build
24+
```
25+
26+
### Editing the Book
27+
To make changes to the book, locate the necessary files in `content/` and use a text editor of your choice. Likewise, any updates to the images can be made using the editing software of your choice on files from the `images/` folder. The stylesheet which contains all of the styling for the book is `stylesheets/pdf.scss`.
28+
29+
Should you need to edit which files are included in the build, open `magicbook.json` with your text editor.
30+
31+
32+
### PDF vs Printed
33+
**IMPORTANT:** Depending on what type of build you are making (printed or digital), make sure to update the last two digits of the ISBN in `content/copyright.html`. The PDF ISBN is designated for the PDF distributed online at [processingfoundation.press](https://processingfoundation.press/) while the PRINT ISBN is designated for the physical copy.
34+
35+
Use a PDF editor/converter such a Adobe Acrobat Pro to attach the correct cover and title page files – as these will also be build-specific. The respective PDF files can be found in `cover/`. All builds must have a title page; if you are creating a physical copy, the full cover will be submitted separately along with an interior-only PDF build.
36+
37+
You may also want to remove the folio on the last two pages (p228-229).

0 commit comments

Comments
 (0)