Skip to content

Commit 2abe74d

Browse files
authored
Merge pull request #182 from smoreface/patch-1
Revise README for Wax project setup instructions
2 parents e9a3993 + 940c8e5 commit 2abe74d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
__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/).
1717

1818

1919
- [Prerequisites](#Prerequisites)
@@ -68,39 +68,39 @@ __There are a few ways to get started with Wax, depending on your needs.__ Copyi
6868

6969
1. Log into your [GitHub account](https://github.com/). (Or sign up if you don't have one!)
7070

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"**.
7272

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,
7474
```sh
75-
[email protected]:mnyrop/my-wax-site.git
75+
[email protected]:username/my-wax-site.git
7676
```
7777

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:
7979
```sh
8080
cd ~/Desktop
8181
```
8282

8383
5. Run the `git clone` command plus the link you copied on your clipboard in one line, e.g.,
8484
```sh
85-
git clone [email protected]:mnyrop/my-wax-site.git
85+
git clone [email protected]:username/my-wax-site.git
8686
```
8787

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:
8989
```sh
9090
cd my-wax-site
9191
```
9292

93-
7. Install the project-specific Ruby dependencies by running the command
93+
7. Install the project-specific Ruby dependencies by running the command:
9494
```sh
9595
bundle install
9696
```
9797

98-
8. Run the demo site:
98+
8. Run the demo site by running the command:
9999
```sh
100100
bundle exec jekyll serve
101101
```
102102

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/).
104104

105105

106106
# Using Docker

0 commit comments

Comments
 (0)