|
13 | 13 |
|
14 | 14 |
|
15 | 15 | __Wax is an extensible workflow for producing scholarly exhibitions with minimal computing principles.__<br> |
16 | | -It's comprised of: __a few Ruby gems__ for processing image data and associated metadata ([wax_tasks](https://github.com/minicomp/wax_tasks/), [wax_iiif](https://github.com/minicomp/wax_iiif/)), __a Jekyll theme__ ([wax_theme](https://github.com/minicomp/wax/)), and (hopefully soon!) a lot of __documentation and recipes__ for creating, deploying, and maintaining digital exhibitions. |
| 16 | +It's comprised of: __a few Ruby gems__ for processing image data and associated metadata ([wax_tasks](https://github.com/minicomp/wax_tasks/), [wax_iiif](https://github.com/minicomp/wax_iiif/)), __a Jekyll theme__ ([wax_theme](https://github.com/minicomp/wax/)), and (hopefully soon!) a lot of __documentation and recipes__ for creating, deploying, and maintaining digital exhibitions. For now, additional documentation is in the [Minicomp/Wax Wiki](https://minicomp.github.io/wiki/wax/). |
17 | 17 |
|
18 | 18 |
|
19 | 19 | - [Prerequisites](#Prerequisites) |
@@ -68,39 +68,39 @@ __There are a few ways to get started with Wax, depending on your needs.__ Copyi |
68 | 68 |
|
69 | 69 | 1. Log into your [GitHub account](https://github.com/). (Or sign up if you don't have one!) |
70 | 70 |
|
71 | | -2. Head to the [Wax demo page](https://github.com/) and click **"Use this Template"** button. It will prompt you to create a copy of the repository in your own account. You should name it after the collection or exhibition you'll make, since this name will inform your free URL for the project with GitHub. For this example, our repository is called **"my-wax-site"**. |
| 71 | +2. Head to the [Wax demo page](https://github.com/minicomp/wax) and click **"Use this template"** button. You will be prompted to create a copy of the repository in your own account. The name you choose will inform your free URL (repository) for the project with GitHub, so name it after the collection or exhibition you'll make. In this example, the repository is called **"my-wax-site"**. |
72 | 72 |
|
73 | | -3. On your own, new Wax repository page, click the Green **"Code"** button and copy the URL it provides to your clipboard, e.g, |
| 73 | +3. On your new Wax repository page, click the Green **"Code"** button and copy the URL it provides to your clipboard, e.g, |
74 | 74 | ```sh |
75 | | - [email protected]: mnyrop/my-wax-site.git |
| 75 | + [email protected]: username/my-wax-site.git |
76 | 76 | ``` |
77 | 77 |
|
78 | | -4. Open your Terminal/Shell application and change directory into where you'd like to work on your project, e.g., your Desktop: |
| 78 | +4. Open your Terminal/Shell application and change directory into where you want to work on your project, e.g., your Desktop: |
79 | 79 | ```sh |
80 | 80 | cd ~/Desktop |
81 | 81 | ``` |
82 | 82 |
|
83 | 83 | 5. Run the `git clone` command plus the link you copied on your clipboard in one line, e.g., |
84 | 84 | ```sh |
85 | | - git clone [email protected]: mnyrop/my-wax-site.git |
| 85 | + git clone [email protected]: username/my-wax-site.git |
86 | 86 | ``` |
87 | 87 |
|
88 | | -6. When the clone is complete, change directory into your newly cloned project folder, in our case: |
| 88 | +6. When the clone is complete, change directory into your newly cloned project folder, in this case: |
89 | 89 | ```sh |
90 | 90 | cd my-wax-site |
91 | 91 | ``` |
92 | 92 |
|
93 | | -7. Install the project-specific Ruby dependencies by running the command |
| 93 | +7. Install the project-specific Ruby dependencies by running the command: |
94 | 94 | ```sh |
95 | 95 | bundle install |
96 | 96 | ``` |
97 | 97 |
|
98 | | -8. Run the demo site: |
| 98 | +8. Run the demo site by running the command: |
99 | 99 | ```sh |
100 | 100 | bundle exec jekyll serve |
101 | 101 | ``` |
102 | 102 |
|
103 | | -After the last step, the terminal will provide you with a localhost URL for you to see your local copy of the site on your browser. This is the template site you will make changes to in order to make your own exhibition. For more, check out the [Minicomp/Wax Wiki](https://minicomp.github.io/wiki/wax/). |
| 103 | +After the last step, the terminal provides you with a localhost URL for you to see a local copy of the site on your web browser. This is the template site you will make changes to in order to make your own exhibition. For more details, check out the [Minicomp/Wax Wiki](https://minicomp.github.io/wiki/wax/). |
104 | 104 |
|
105 | 105 |
|
106 | 106 | # Using Docker |
|
0 commit comments