Skip to content

Commit c8d5311

Browse files
KRoysEzCatervnegrisolo
authored andcommitted
Revise README for clarity on open-sourcing and setup
- clarify open-source purpose - explicit installation options for folks who don't read everything before starting - center Hashrocket image - general copy editing
1 parent b79c935 commit c8d5311

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88
> is open to any Rocketeer as well as select friends of the team. We hope you
99
> enjoy learning along with us.
1010
11-
This site was open-sourced in as a window into our development process, as well as
12-
to allow people to experiment with the site on their own and contribute to the
13-
project.
11+
Today I Learned was open-sourced to:
12+
- provide a window into our development process
13+
- allow people to experiment with the site on their own
14+
- allow folks to contribute back to the project
1415

1516
We originally implemented Tilex as [_hr-til_][hr-til], a Ruby on Rails app.
1617

@@ -41,8 +42,10 @@ $ make
4142
$ make setup server
4243
```
4344

44-
To do everything by hand, source your environment variables, install
45-
dependencies, and start the server:
45+
#### Option 1 (seeded db)
46+
47+
Source your environment variables, install
48+
dependencies, seed the db, and start the server:
4649

4750
```shell
4851
$ cp .env{.example,}
@@ -53,8 +56,24 @@ $ npm install --prefix assets
5356
$ mix phx.server
5457
```
5558

56-
Want to start with an empty database? Skip the seeds by running `mix ecto.create && mix
57-
ecto.migrate` in place of `mix ecto.setup`.
59+
### Option 2 (empty db)
60+
61+
For those who prefer to start with a blank slate:
62+
63+
```shell
64+
$ cp .env{.example,}
65+
$ source .env
66+
$ mix deps.get
67+
$ mix ecto.create && mix ecto.migrate
68+
$ npm install --prefix assets
69+
$ mix phx.server
70+
```
71+
72+
### Running the application
73+
74+
```shell
75+
$ mix phx.server
76+
```
5877

5978
Now you can visit http://localhost:4000 from your browser.
6079

@@ -90,7 +109,7 @@ user on subsequent authentications.
90109
### Testing
91110

92111
Wallaby relies on [ChromeDriver][chromedriver]; install it via your method of
93-
choice. Then, run tests with:
112+
choice. Then, run tests with:
94113

95114
```shell
96115
$ make test
@@ -139,13 +158,12 @@ see [LICENSE](LICENSE.md) for more information.
139158

140159
---
141160

142-
### About
143-
144-
[![Hashrocket logo](https://hashrocket.com/hashrocket_logo.svg)][hashrocket]
161+
<p align="center">
162+
<img src="https://hashrocket.com/hashrocket_logo.svg" />
163+
</p>
145164

146-
Tilex is supported by the team at [Hashrocket, a multidisciplinary design and
147-
development consultancy][hashrocket] If you'd like to [work with us][hire-us]
148-
or [join our team][join-us], don't hesitate to get in touch.
165+
Tilex is supported by the team at [Hashrocket][hashrocket], a multidisciplinary design and
166+
development consultancy. If you'd like to work with us, don't hesitate to [contact us][hire-us] today!
149167

150168
[asdf]: https://github.com/asdf-vm/asdf
151169
[cc]: http://contributor-covenant.org

0 commit comments

Comments
 (0)