Skip to content

Commit

Permalink
fixed formatting of README.md for readability
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgas committed Jun 6, 2020
1 parent e7961a9 commit 18d8bc4
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,46 +15,46 @@ Data is stored locally on device in [PouchDB](https://pouchdb.com/) database and

Implemented with [React](https://github.com/facebook/react) and [Semantic UI](https://github.com/Semantic-Org/Semantic-UI-React)

**License**

# # License
Our software is distributed under the MIT License.

**Installation**
# # Installation

# # # Prerequisites
- npm, which you can install by running:

- Prerequisites
npm, which you can install by running:
```npm install npm@latest –g```

npm install npm@latest –g
- How to install
* Clone the repo from this website, then
* In command line:

- How to install
• Clone the repo from this website, then
• In command line:
$ git clone https://github.com/ayastreb/money-tracker.git
$ cd money-tracker
$ npm install react-scripts
$ npm start
```$ git clone https://github.com/ayastreb/money-tracker.git```
```$ cd money-tracker```
```$ npm install react-scripts```
```$ npm start```

At this point you can see the app running on
At this point you can see the app running on

http://localhost:3000
```http://localhost:3000```

And start developing for contribution.
And start developing for contribution.

If any questions arise, please see the [open issues](https://github.com/ayastreb/money-tracker/issues) tab as some of them might have already been answered.

**Contributing**
# # Contributing

If you would like to contribute, please follow these steps:
1. Open an issue explaining what you want to fix
2. Fork this project
3. Create a featureDev_<YourFeaturedName> branch
4. Add and commit your contribution (s)
5. Push to your featureDev_<YourFeaturedName> branch
6. Open a pull request (PR)
1. Open an issue explaining what you want to fix
2. Fork this project
3. Create a ```featureDev_<YourFeaturedName>``` branch
4. Add and commit your contribution (s)
5. Push to your ```featureDev_<YourFeaturedName>``` branch
6. Open a pull request (PR)

As always, if any questions arise, please connect with us via our <communication channel> (see below).
As always, if any questions arise, please connect with us via our < communication channel > (see below).

**Community Standards**
# # Community Standards

It is our responsibility to build a strong and welcoming community for all developers. Everyone who is willing to contribute is welcome, and her or his work will be considered if it solves an issue.

Expand All @@ -64,10 +64,10 @@ Please keep in mind that everyone:
• Must accept constructive criticism, and aim for continues improvement
• Must support and show empathy towards other community members

**Communication Channels**
# # Communication Channels

<please add here your preferred communication channel>
< please add here your preferred communication channel >

**Development Tracking**
# # Development Tracking

See the [open issues](https://github.com/ayastreb/money-tracker/issues) for a list of proposed features (and known issues).

0 comments on commit 18d8bc4

Please sign in to comment.