Skip to content

Commit c177b14

Browse files
authored
Merge pull request #65 from ishythefishy/refine-readme
Added more detail to README
2 parents 4abcd86 + 5447a1b commit c177b14

File tree

1 file changed

+38
-18
lines changed

1 file changed

+38
-18
lines changed

README.md

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,7 @@
33

44
<img src="https://www.fretonator.com/assets/img/og_twitter.png">
55

6-
## Thanks for checking out the Fretonator!
7-
8-
I’m a qualified music teacher that (somehow) ended up working as a lead software engineer (it’s a long story), and I built this for my husban️d.
9-
10-
He’s a phenomenal guitarist, and over the past few years has worked on learning modes and scale theory for the guitar (with a little help from me). Obviously, the internet is great for this kind of stuff, but what he felt the world wide web was lacking was an interactive and informative tool to could use in his practice sessions that had everything he needed on one single page.
11-
12-
## Enter the Fretonator!
6+
---
137

148
The Fretonator is your new interactive tool for learning common modes on the guitar, understanding the chord theory behind the modes, and most importantly - having a jam.
159

@@ -30,49 +24,75 @@ Angular Prerender
3024
Netlify
3125
```
3226

27+
## The Fretonator is open source!
28+
29+
[Apache License, v2.0](https://github.com/ishythefishy/fretonator/blob/master/LICENSE)
30+
31+
Want to contribute to the Fretonator? Here's now in 12 simple steps...
32+
33+
### System requirements:
34+
35+
```
36+
Node 14
37+
NPM
38+
```
3339

3440
### Build Instructions
35-
Requires Node (14) & NPM.
3641

37-
1. Ensure Node Package Manager (NPM) and Angular CLI (NG) are installed.
42+
[1] Ensure Node Package Manager (NPM) and Angular CLI (NG) are installed.
43+
3844
```
3945
npm -v
4046
npm install -g @angular/cli
41-
ng --version
4247
```
4348

44-
2. Fork the repository.
49+
[2] Fork the repository.
4550

46-
3. Clone your fork to your local development environment.
51+
[3] Clone your fork to your local development environment.
4752
```
4853
git clone [url]
4954
```
5055

51-
4. Change into the Fretonator directory.
56+
[4] Navigate to the Fretonator directory.
5257
```
5358
cd fretonator
5459
```
5560

56-
5. Install the dependencies.
61+
[5] Install the dependencies.
5762
```
5863
npm install
5964
```
6065

61-
6. Run the local development server. This should open automatically in your browser but would be accessible via http://localhost:4200/.
66+
[6] Run your local development server.
67+
68+
The `--open` flag opens the application in your browser automatically and is not required.
69+
6270
```
6371
ng serve --open
6472
```
6573

74+
[7] Navigate to http://localhost:4200/ in your browser.
75+
76+
[8] Write some code!
77+
78+
[9] Open a pull request, and I'll take a look!
79+
80+
[10] Things get merged.
81+
82+
[11] A Netlify deployment is triggered automatically.
83+
84+
###[12] PROFIT!!!
85+
6686
---
67-
```
68-
This project was generated using [Nx](https://nx.dev).
69-
```
87+
7088
See `package.json` for test and build commands available to the project.
7189

7290
### www.fretonator.com
7391

7492
---
7593

94+
## Other technical stuff
95+
7696
This project was generated using [Nx](https://nx.dev).
7797

7898
🔎 **Nx is a set of Extensible Dev Tools for Monorepos.**

0 commit comments

Comments
 (0)